Class protos.google.cloud.kms.v1.EncryptRequest

Represents an EncryptRequest.

Package

@google-cloud/kms!

Constructors

(constructor)(properties)

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

Constructs a new EncryptRequest.

Parameter
TypeNameDescription
google.cloud.kms.v1.IEncryptRequestproperties

Properties to set

Properties

additionalAuthenticatedData

public additionalAuthenticatedData: (Uint8Array|string);

EncryptRequest additionalAuthenticatedData.

Property Value
TypeDescription
(Uint8Array|string)

additionalAuthenticatedDataCrc32c

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

EncryptRequest additionalAuthenticatedDataCrc32c.

Property Value
TypeDescription
(google.protobuf.IInt64Value|null)

name

public name: string;

EncryptRequest name.

Property Value
TypeDescription
string

plaintext

public plaintext: (Uint8Array|string);

EncryptRequest plaintext.

Property Value
TypeDescription
(Uint8Array|string)

plaintextCrc32c

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

EncryptRequest plaintextCrc32c.

Property Value
TypeDescription
(google.protobuf.IInt64Value|null)

Methods

create(properties)

public static create(properties?: google.cloud.kms.v1.IEncryptRequest): google.cloud.kms.v1.EncryptRequest;

Creates a new EncryptRequest instance using the specified properties.

Parameter
TypeNameDescription
google.cloud.kms.v1.IEncryptRequestproperties

Properties to set

Returns
TypeDescription
google.cloud.kms.v1.EncryptRequest

EncryptRequest instance

decode(reader, length)

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

Decodes an EncryptRequest message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.cloud.kms.v1.EncryptRequest

EncryptRequest

decodeDelimited(reader)

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

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.kms.v1.EncryptRequest

EncryptRequest

encode(message, writer)

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

Encodes the specified EncryptRequest message. Does not implicitly messages.

Parameters
TypeNameDescription
google.cloud.kms.v1.IEncryptRequestmessage

EncryptRequest message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
TypeNameDescription
google.cloud.kms.v1.IEncryptRequestmessage

EncryptRequest message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
TypeNameDescription
{ [k: string]: any }object

Plain object

Returns
TypeDescription
google.cloud.kms.v1.EncryptRequest

EncryptRequest

toJSON()

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

Converts this EncryptRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.cloud.kms.v1.EncryptRequestmessage

EncryptRequest

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an EncryptRequest message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not