Class protos.google.cloud.kms.v1.UpdateCryptoKeyRequest

Represents an UpdateCryptoKeyRequest.

Package

@google-cloud/kms!

Constructors

(constructor)(properties)

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

Constructs a new UpdateCryptoKeyRequest.

Parameter

Type	Name	Description
IUpdateCryptoKeyRequest	properties	Properties to set

Properties

cryptoKey

public cryptoKey?: (google.cloud.kms.v1.ICryptoKey|null);

UpdateCryptoKeyRequest cryptoKey.

Property Value

Type	Description
(google.cloud.kms.v1.ICryptoKey\|null)

updateMask

public updateMask?: (google.protobuf.IFieldMask|null);

UpdateCryptoKeyRequest updateMask.

Property Value

Type	Description
(google.protobuf.IFieldMask\|null)

Methods

create(properties)

public static create(properties?: google.cloud.kms.v1.IUpdateCryptoKeyRequest): google.cloud.kms.v1.UpdateCryptoKeyRequest;

Creates a new UpdateCryptoKeyRequest instance using the specified properties.

Parameter

Type	Name	Description
IUpdateCryptoKeyRequest	properties	Properties to set

Returns

Type	Description
google.cloud.kms.v1.UpdateCryptoKeyRequest	UpdateCryptoKeyRequest instance

decode(reader, length)

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

Decodes an UpdateCryptoKeyRequest message from the specified reader or buffer.

Parameters

Type	Name	Description
($protobuf.Reader\|Uint8Array)	reader	Reader or buffer to decode from
number	length	Message length if known beforehand

Returns

Type	Description
google.cloud.kms.v1.UpdateCryptoKeyRequest	UpdateCryptoKeyRequest

decodeDelimited(reader)

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

Decodes an UpdateCryptoKeyRequest message from the specified reader or buffer, length delimited.

Parameter

Type	Name	Description
($protobuf.Reader\|Uint8Array)	reader	Reader or buffer to decode from

Returns

Type	Description
google.cloud.kms.v1.UpdateCryptoKeyRequest	UpdateCryptoKeyRequest

encode(message, writer)

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

Encodes the specified UpdateCryptoKeyRequest message. Does not implicitly messages.

Parameters

Type	Name	Description
IUpdateCryptoKeyRequest	message	UpdateCryptoKeyRequest message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

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

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

Parameters

Type	Name	Description
IUpdateCryptoKeyRequest	message	UpdateCryptoKeyRequest message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

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

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

Parameter

Type	Name	Description
{ [k: string]: any }	object	Plain object

Returns

Type	Description
google.cloud.kms.v1.UpdateCryptoKeyRequest	UpdateCryptoKeyRequest

toJSON()

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

Converts this UpdateCryptoKeyRequest to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Type	Name	Description
google.cloud.kms.v1.UpdateCryptoKeyRequest	message	UpdateCryptoKeyRequest
$protobuf.IConversionOptions	options	Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

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

Verifies an UpdateCryptoKeyRequest message.

Parameter

Type	Name	Description
{ [k: string]: any }	message	Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not