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

CryptoKeyVersionAlgorithm

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
EC_SIGN_SECP256K1_SHA256 number

EC_SIGN_SECP256K1_SHA256 value
HMAC_SHA256 number

HMAC_SHA256 value
EXTERNAL_SYMMETRIC_ENCRYPTION number

EXTERNAL_SYMMETRIC_ENCRYPTION value

CryptoKeyVersionState

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

CryptoKeyVersionView

CryptoKeyVersionView enum.

Properties:
Name Type Description
CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED number

CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED value
FULL number

FULL value

algorithm

CryptoKeyVersion algorithm.

attestation

CryptoKeyVersion attestation.

createTime

CryptoKeyVersion createTime.

destroyEventTime

CryptoKeyVersion destroyEventTime.

destroyTime

CryptoKeyVersion destroyTime.

externalProtectionLevelOptions

CryptoKeyVersion externalProtectionLevelOptions.

generateTime

CryptoKeyVersion generateTime.

importFailureReason

CryptoKeyVersion importFailureReason.

importJob

CryptoKeyVersion importJob.

importTime

CryptoKeyVersion importTime.

name

CryptoKeyVersion name.

protectionLevel

CryptoKeyVersion protectionLevel.

state

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
Returns:
Type Description
google.cloud.kms.v1.CryptoKeyVersion

CryptoKeyVersion instance

(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
Returns:
Type Description
google.cloud.kms.v1.CryptoKeyVersion

CryptoKeyVersion
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
Returns:
Type Description
google.cloud.kms.v1.CryptoKeyVersion

CryptoKeyVersion
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
Returns:
Type Description
$protobuf.Writer

Writer

(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
Returns:
Type Description
$protobuf.Writer

Writer

(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
Returns:
Type Description
google.cloud.kms.v1.CryptoKeyVersion

CryptoKeyVersion

(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
Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a CryptoKeyVersion message.

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

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

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

Converts this CryptoKeyVersion to JSON.

Returns:
Type Description
Object.<string, *>

JSON object