Class protos.google.cloud.tpu.v2alpha1.CustomerEncryptionKey (3.2.0)

Represents a CustomerEncryptionKey.

Package

@google-cloud/tpu

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.tpu.v2alpha1.ICustomerEncryptionKey);

Constructs a new CustomerEncryptionKey.

Parameter
NameDescription
properties ICustomerEncryptionKey

Properties to set

Properties

key

public key?: "kmsKeyName";

CustomerEncryptionKey key.

kmsKeyName

public kmsKeyName?: (string|null);

CustomerEncryptionKey kmsKeyName.

Methods

create(properties)

public static create(properties?: google.cloud.tpu.v2alpha1.ICustomerEncryptionKey): google.cloud.tpu.v2alpha1.CustomerEncryptionKey;

Creates a new CustomerEncryptionKey instance using the specified properties.

Parameter
NameDescription
properties ICustomerEncryptionKey

Properties to set

Returns
TypeDescription
CustomerEncryptionKey

CustomerEncryptionKey instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.tpu.v2alpha1.CustomerEncryptionKey;

Decodes a CustomerEncryptionKey message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
CustomerEncryptionKey

CustomerEncryptionKey

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.tpu.v2alpha1.CustomerEncryptionKey;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
CustomerEncryptionKey

CustomerEncryptionKey

encode(message, writer)

public static encode(message: google.cloud.tpu.v2alpha1.ICustomerEncryptionKey, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CustomerEncryptionKey message. Does not implicitly messages.

Parameters
NameDescription
message ICustomerEncryptionKey

CustomerEncryptionKey message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.tpu.v2alpha1.ICustomerEncryptionKey, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ICustomerEncryptionKey

CustomerEncryptionKey message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.tpu.v2alpha1.CustomerEncryptionKey;

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

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

Plain object

Returns
TypeDescription
CustomerEncryptionKey

CustomerEncryptionKey

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CustomerEncryptionKey

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this CustomerEncryptionKey to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message CustomerEncryptionKey

CustomerEncryptionKey

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a CustomerEncryptionKey message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not