Class protos.google.cloud.kms.v1.CryptoKeyVersion

Represents a CryptoKeyVersion.

Package

@google-cloud/kms!

Constructors

(constructor)(properties)

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

Constructs a new CryptoKeyVersion.

Parameter

Type	Name	Description
ICryptoKeyVersion	properties	Properties to set

Properties

algorithm

public algorithm: (google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm|keyof typeof google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm);

CryptoKeyVersion algorithm.

Property Value

Type	Description
(google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm\|keyof typeof google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm)

attestation

public attestation?: (google.cloud.kms.v1.IKeyOperationAttestation|null);

CryptoKeyVersion attestation.

Property Value

Type	Description
(google.cloud.kms.v1.IKeyOperationAttestation\|null)

createTime

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

CryptoKeyVersion createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

destroyEventTime

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

CryptoKeyVersion destroyEventTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

destroyTime

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

CryptoKeyVersion destroyTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

externalProtectionLevelOptions

public externalProtectionLevelOptions?: (google.cloud.kms.v1.IExternalProtectionLevelOptions|null);

CryptoKeyVersion externalProtectionLevelOptions.

Property Value

Type	Description
(google.cloud.kms.v1.IExternalProtectionLevelOptions\|null)

generateTime

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

CryptoKeyVersion generateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

importFailureReason

public importFailureReason: string;

CryptoKeyVersion importFailureReason.

Property Value

Type	Description
string

importJob

public importJob: string;

CryptoKeyVersion importJob.

Property Value

Type	Description
string

importTime

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

CryptoKeyVersion importTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

name

public name: string;

CryptoKeyVersion name.

Property Value

Type	Description
string

protectionLevel

public protectionLevel: (google.cloud.kms.v1.ProtectionLevel|keyof typeof google.cloud.kms.v1.ProtectionLevel);

CryptoKeyVersion protectionLevel.

Property Value

Type	Description
(google.cloud.kms.v1.ProtectionLevel\|keyof typeof google.cloud.kms.v1.ProtectionLevel)

state

public state: (google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState|keyof typeof google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState);

CryptoKeyVersion state.

Property Value

Type	Description
(google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState\|keyof typeof google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState)

Methods

create(properties)

public static create(properties?: google.cloud.kms.v1.ICryptoKeyVersion): google.cloud.kms.v1.CryptoKeyVersion;

Creates a new CryptoKeyVersion instance using the specified properties.

Parameter

Type	Name	Description
ICryptoKeyVersion	properties	Properties to set

Returns

Type	Description
google.cloud.kms.v1.CryptoKeyVersion	CryptoKeyVersion instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified CryptoKeyVersion message. Does not implicitly messages.

Parameters

Type	Name	Description
ICryptoKeyVersion	message	CryptoKeyVersion 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.ICryptoKeyVersion, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Type	Name	Description
ICryptoKeyVersion	message	CryptoKeyVersion 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.CryptoKeyVersion;

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

toJSON()

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

Converts this CryptoKeyVersion to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Type	Name	Description
google.cloud.kms.v1.CryptoKeyVersion	message	CryptoKeyVersion
$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 CryptoKeyVersion 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