Class protos.google.cloud.netapp.v1.KmsConfig (0.2.0)

Represents a KmsConfig.

Package

@google-cloud/netapp

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.netapp.v1.IKmsConfig);

Constructs a new KmsConfig.

Parameter
NameDescription
properties IKmsConfig

Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

KmsConfig createTime.

cryptoKeyName

public cryptoKeyName: string;

KmsConfig cryptoKeyName.

description

public description: string;

KmsConfig description.

instructions

public instructions: string;

KmsConfig instructions.

labels

public labels: { [k: string]: string };

KmsConfig labels.

name

public name: string;

KmsConfig name.

serviceAccount

public serviceAccount: string;

KmsConfig serviceAccount.

state

public state: (google.cloud.netapp.v1.KmsConfig.State|keyof typeof google.cloud.netapp.v1.KmsConfig.State);

KmsConfig state.

stateDetails

public stateDetails: string;

KmsConfig stateDetails.

Methods

create(properties)

public static create(properties?: google.cloud.netapp.v1.IKmsConfig): google.cloud.netapp.v1.KmsConfig;

Creates a new KmsConfig instance using the specified properties.

Parameter
NameDescription
properties IKmsConfig

Properties to set

Returns
TypeDescription
KmsConfig

KmsConfig instance

decode(reader, length)

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

Decodes a KmsConfig 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
KmsConfig

KmsConfig

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
KmsConfig

KmsConfig

encode(message, writer)

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

Encodes the specified KmsConfig message. Does not implicitly messages.

Parameters
NameDescription
message IKmsConfig

KmsConfig 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.netapp.v1.IKmsConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IKmsConfig

KmsConfig 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.netapp.v1.KmsConfig;

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

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

Plain object

Returns
TypeDescription
KmsConfig

KmsConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for KmsConfig

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 KmsConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message KmsConfig

KmsConfig

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 KmsConfig 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