Class protos.google.cloud.kms.v1.DecryptRequest (2.11.0)

Represents a DecryptRequest.

Package

Constructors

(constructor)(properties)

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

Constructs a new DecryptRequest.

Parameter

Name	Description
properties	`IDecryptRequest` Properties to set

Properties

additionalAuthenticatedData

public additionalAuthenticatedData: (Uint8Array|string);

DecryptRequest additionalAuthenticatedData.

additionalAuthenticatedDataCrc32c

public additionalAuthenticatedDataCrc32c?: (google.protobuf.IInt64Value|null);

DecryptRequest additionalAuthenticatedDataCrc32c.

ciphertext

public ciphertext: (Uint8Array|string);

DecryptRequest ciphertext.

ciphertextCrc32c

public ciphertextCrc32c?: (google.protobuf.IInt64Value|null);

DecryptRequest ciphertextCrc32c.

name

public name: string;

DecryptRequest name.

Methods

create(properties)

public static create(properties?: google.cloud.kms.v1.IDecryptRequest): google.cloud.kms.v1.DecryptRequest;

Creates a new DecryptRequest instance using the specified properties.

Parameter

Name	Description
properties	`IDecryptRequest` Properties to set

Returns

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

decode(reader, length)

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

Decodes a DecryptRequest message from the specified reader or buffer.

Parameters

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

Returns

Type	Description
google.cloud.kms.v1.DecryptRequest	DecryptRequest

decodeDelimited(reader)

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

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

Parameter

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

Returns

Type	Description
google.cloud.kms.v1.DecryptRequest	DecryptRequest

encode(message, writer)

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

Encodes the specified DecryptRequest message. Does not implicitly messages.

Parameters

Name	Description
message	`IDecryptRequest` DecryptRequest 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.IDecryptRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IDecryptRequest` DecryptRequest 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.DecryptRequest;

Creates a DecryptRequest 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
google.cloud.kms.v1.DecryptRequest	DecryptRequest

toJSON()

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

Converts this DecryptRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.kms.v1.DecryptRequest` DecryptRequest
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 DecryptRequest 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