Class protos.google.cloud.kms.v1.GetPublicKeyRequest

Represents a GetPublicKeyRequest.

Package

@google-cloud/kms!

Constructors

(constructor)(properties)

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

Constructs a new GetPublicKeyRequest.

Parameter
Type Name Description
IGetPublicKeyRequest properties

Properties to set

Properties

name

public name: string;

GetPublicKeyRequest name.

Property Value
Type Description
string

Methods

create(properties)

public static create(properties?: google.cloud.kms.v1.IGetPublicKeyRequest): google.cloud.kms.v1.GetPublicKeyRequest;

Creates a new GetPublicKeyRequest instance using the specified properties.

Parameter
Type Name Description
IGetPublicKeyRequest properties

Properties to set
Returns
Type Description
google.cloud.kms.v1.GetPublicKeyRequest

GetPublicKeyRequest instance

decode(reader, length)

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

Decodes a GetPublicKeyRequest 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.GetPublicKeyRequest

GetPublicKeyRequest

decodeDelimited(reader)

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

Decodes a GetPublicKeyRequest 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.GetPublicKeyRequest

GetPublicKeyRequest

encode(message, writer)

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

Encodes the specified GetPublicKeyRequest message. Does not implicitly messages.

Parameters
Type Name Description
IGetPublicKeyRequest message

GetPublicKeyRequest 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.IGetPublicKeyRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Type Name Description
IGetPublicKeyRequest message

GetPublicKeyRequest 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.GetPublicKeyRequest;

Creates a GetPublicKeyRequest 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.GetPublicKeyRequest

GetPublicKeyRequest

toJSON()

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

Converts this GetPublicKeyRequest to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Type Name Description
google.cloud.kms.v1.GetPublicKeyRequest message

GetPublicKeyRequest
$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 a GetPublicKeyRequest 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