Class protos.google.cloud.kms.v1.ExternalProtectionLevelOptions

Represents an ExternalProtectionLevelOptions.

Package

@google-cloud/kms!

Constructors

(constructor)(properties)

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

Constructs a new ExternalProtectionLevelOptions.

Parameter
Type Name Description
IExternalProtectionLevelOptions properties

Properties to set

Properties

externalKeyUri

public externalKeyUri: string;

ExternalProtectionLevelOptions externalKeyUri.

Property Value
Type Description
string

Methods

create(properties)

public static create(properties?: google.cloud.kms.v1.IExternalProtectionLevelOptions): google.cloud.kms.v1.ExternalProtectionLevelOptions;

Creates a new ExternalProtectionLevelOptions instance using the specified properties.

Parameter
Type Name Description
IExternalProtectionLevelOptions properties

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

ExternalProtectionLevelOptions instance

decode(reader, length)

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

Decodes an ExternalProtectionLevelOptions 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.ExternalProtectionLevelOptions

ExternalProtectionLevelOptions

decodeDelimited(reader)

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

Decodes an ExternalProtectionLevelOptions 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.ExternalProtectionLevelOptions

ExternalProtectionLevelOptions

encode(message, writer)

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

Encodes the specified ExternalProtectionLevelOptions message. Does not implicitly messages.

Parameters
Type Name Description
IExternalProtectionLevelOptions message

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

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

Parameters
Type Name Description
IExternalProtectionLevelOptions message

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

Creates an ExternalProtectionLevelOptions 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.ExternalProtectionLevelOptions

ExternalProtectionLevelOptions

toJSON()

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

Converts this ExternalProtectionLevelOptions to JSON.

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

JSON object

toObject(message, options)

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

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

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

ExternalProtectionLevelOptions
$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 an ExternalProtectionLevelOptions 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