Class protos.google.cloud.kms.v1.CreateKeyHandleMetadata (4.3.0)

Represents a CreateKeyHandleMetadata.

Package

@google-cloud/kms

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.kms.v1.ICreateKeyHandleMetadata);

Constructs a new CreateKeyHandleMetadata.

Parameter
Name Description
properties ICreateKeyHandleMetadata

Properties to set

Methods

create(properties)

public static create(properties?: google.cloud.kms.v1.ICreateKeyHandleMetadata): google.cloud.kms.v1.CreateKeyHandleMetadata;

Creates a new CreateKeyHandleMetadata instance using the specified properties.

Parameter
Name Description
properties ICreateKeyHandleMetadata

Properties to set

Returns
Type Description
CreateKeyHandleMetadata

CreateKeyHandleMetadata instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.kms.v1.CreateKeyHandleMetadata;

Decodes a CreateKeyHandleMetadata message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
CreateKeyHandleMetadata

CreateKeyHandleMetadata

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.kms.v1.CreateKeyHandleMetadata;

Decodes a CreateKeyHandleMetadata message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CreateKeyHandleMetadata

CreateKeyHandleMetadata

encode(message, writer)

public static encode(message: google.cloud.kms.v1.ICreateKeyHandleMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CreateKeyHandleMetadata message. Does not implicitly messages.

Parameters
Name Description
message ICreateKeyHandleMetadata

CreateKeyHandleMetadata message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.kms.v1.ICreateKeyHandleMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CreateKeyHandleMetadata message, length delimited. Does not implicitly messages.

Parameters
Name Description
message ICreateKeyHandleMetadata

CreateKeyHandleMetadata message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.kms.v1.CreateKeyHandleMetadata;

Creates a CreateKeyHandleMetadata message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
CreateKeyHandleMetadata

CreateKeyHandleMetadata

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for CreateKeyHandleMetadata

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this CreateKeyHandleMetadata to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.kms.v1.CreateKeyHandleMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a CreateKeyHandleMetadata message. Also converts values to other types if specified.

Parameters
Name Description
message CreateKeyHandleMetadata

CreateKeyHandleMetadata

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a CreateKeyHandleMetadata message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not