CryptoKeyVersion

google.cloud.kms.v1. CryptoKeyVersion

Represents a CryptoKeyVersion.

Constructor

new CryptoKeyVersion(propertiesopt)

Constructs a new CryptoKeyVersion.

Parameters:
Name Type Attributes Description
properties google.cloud.kms.v1.ICryptoKeyVersion <optional>

Properties to set
Implements:
  • ICryptoKeyVersion

Members

(static) CryptoKeyVersionAlgorithm :number

CryptoKeyVersionAlgorithm enum.

Properties:
Name Type Description
CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED number

CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED value
GOOGLE_SYMMETRIC_ENCRYPTION number

GOOGLE_SYMMETRIC_ENCRYPTION value
RSA_SIGN_PSS_2048_SHA256 number

RSA_SIGN_PSS_2048_SHA256 value
RSA_SIGN_PSS_3072_SHA256 number

RSA_SIGN_PSS_3072_SHA256 value
RSA_SIGN_PSS_4096_SHA256 number

RSA_SIGN_PSS_4096_SHA256 value
RSA_SIGN_PSS_4096_SHA512 number

RSA_SIGN_PSS_4096_SHA512 value
RSA_SIGN_PKCS1_2048_SHA256 number

RSA_SIGN_PKCS1_2048_SHA256 value
RSA_SIGN_PKCS1_3072_SHA256 number

RSA_SIGN_PKCS1_3072_SHA256 value
RSA_SIGN_PKCS1_4096_SHA256 number

RSA_SIGN_PKCS1_4096_SHA256 value
RSA_SIGN_PKCS1_4096_SHA512 number

RSA_SIGN_PKCS1_4096_SHA512 value
RSA_DECRYPT_OAEP_2048_SHA256 number

RSA_DECRYPT_OAEP_2048_SHA256 value
RSA_DECRYPT_OAEP_3072_SHA256 number

RSA_DECRYPT_OAEP_3072_SHA256 value
RSA_DECRYPT_OAEP_4096_SHA256 number

RSA_DECRYPT_OAEP_4096_SHA256 value
RSA_DECRYPT_OAEP_4096_SHA512 number

RSA_DECRYPT_OAEP_4096_SHA512 value
EC_SIGN_P256_SHA256 number

EC_SIGN_P256_SHA256 value
EC_SIGN_P384_SHA384 number

EC_SIGN_P384_SHA384 value
EXTERNAL_SYMMETRIC_ENCRYPTION number

EXTERNAL_SYMMETRIC_ENCRYPTION value

(static) CryptoKeyVersionState :number

CryptoKeyVersionState enum.

Properties:
Name Type Description
CRYPTO_KEY_VERSION_STATE_UNSPECIFIED number

CRYPTO_KEY_VERSION_STATE_UNSPECIFIED value
PENDING_GENERATION number

PENDING_GENERATION value
ENABLED number

ENABLED value
DISABLED number

DISABLED value
DESTROYED number

DESTROYED value
DESTROY_SCHEDULED number

DESTROY_SCHEDULED value
PENDING_IMPORT number

PENDING_IMPORT value
IMPORT_FAILED number

IMPORT_FAILED value

(static) CryptoKeyVersionView :number

CryptoKeyVersionView enum.

Properties:
Name Type Description
CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED number

CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED value
FULL number

FULL value

algorithm :google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm

CryptoKeyVersion algorithm.

attestation :google.cloud.kms.v1.IKeyOperationAttestation|null|undefined

CryptoKeyVersion attestation.

createTime :google.protobuf.ITimestamp|null|undefined

CryptoKeyVersion createTime.

destroyEventTime :google.protobuf.ITimestamp|null|undefined

CryptoKeyVersion destroyEventTime.

destroyTime :google.protobuf.ITimestamp|null|undefined

CryptoKeyVersion destroyTime.

externalProtectionLevelOptions :google.cloud.kms.v1.IExternalProtectionLevelOptions|null|undefined

CryptoKeyVersion externalProtectionLevelOptions.

generateTime :google.protobuf.ITimestamp|null|undefined

CryptoKeyVersion generateTime.

importFailureReason :string

CryptoKeyVersion importFailureReason.

importJob :string

CryptoKeyVersion importJob.

importTime :google.protobuf.ITimestamp|null|undefined

CryptoKeyVersion importTime.

name :string

CryptoKeyVersion name.

protectionLevel :google.cloud.kms.v1.ProtectionLevel

CryptoKeyVersion protectionLevel.

state :google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState

CryptoKeyVersion state.

Methods

(static) create(propertiesopt) → {google.cloud.kms.v1.CryptoKeyVersion}

Creates a new CryptoKeyVersion instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.kms.v1.ICryptoKeyVersion <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.cloud.kms.v1.CryptoKeyVersion}

Decodes a CryptoKeyVersion message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.kms.v1.CryptoKeyVersion}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified CryptoKeyVersion message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.kms.v1.ICryptoKeyVersion

CryptoKeyVersion message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.kms.v1.ICryptoKeyVersion

CryptoKeyVersion message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.cloud.kms.v1.CryptoKeyVersion}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.kms.v1.CryptoKeyVersion

CryptoKeyVersion
options $protobuf.IConversionOptions <optional>

Conversion options

(static) verify(message) → {string|null}

Verifies a CryptoKeyVersion message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

toJSON() → {Object.<string, *>}

Converts this CryptoKeyVersion to JSON.