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
algorithm
CryptoKeyVersion algorithm.
attestation
CryptoKeyVersion attestation.
createTime
CryptoKeyVersion createTime.
destroyEventTime
CryptoKeyVersion destroyEventTime.
destroyTime
CryptoKeyVersion destroyTime.
externalDestructionFailureReason
CryptoKeyVersion externalDestructionFailureReason.
externalProtectionLevelOptions
CryptoKeyVersion externalProtectionLevelOptions.
generateTime
CryptoKeyVersion generateTime.
generationFailureReason
CryptoKeyVersion generationFailureReason.
importFailureReason
CryptoKeyVersion importFailureReason.
importJob
CryptoKeyVersion importJob.
importTime
CryptoKeyVersion importTime.
name
CryptoKeyVersion name.
protectionLevel
CryptoKeyVersion protectionLevel.
reimportEligible
CryptoKeyVersion reimportEligible.
state
CryptoKeyVersion state.
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 |
AES_128_GCM |
number |
AES_128_GCM value |
AES_256_GCM |
number |
AES_256_GCM value |
AES_128_CBC |
number |
AES_128_CBC value |
AES_256_CBC |
number |
AES_256_CBC value |
AES_128_CTR |
number |
AES_128_CTR value |
AES_256_CTR |
number |
AES_256_CTR 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_SIGN_RAW_PKCS1_2048 |
number |
RSA_SIGN_RAW_PKCS1_2048 value |
RSA_SIGN_RAW_PKCS1_3072 |
number |
RSA_SIGN_RAW_PKCS1_3072 value |
RSA_SIGN_RAW_PKCS1_4096 |
number |
RSA_SIGN_RAW_PKCS1_4096 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 |
RSA_DECRYPT_OAEP_2048_SHA1 |
number |
RSA_DECRYPT_OAEP_2048_SHA1 value |
RSA_DECRYPT_OAEP_3072_SHA1 |
number |
RSA_DECRYPT_OAEP_3072_SHA1 value |
RSA_DECRYPT_OAEP_4096_SHA1 |
number |
RSA_DECRYPT_OAEP_4096_SHA1 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 |
EC_SIGN_ED25519 |
number |
EC_SIGN_ED25519 value |
HMAC_SHA256 |
number |
HMAC_SHA256 value |
HMAC_SHA1 |
number |
HMAC_SHA1 value |
HMAC_SHA384 |
number |
HMAC_SHA384 value |
HMAC_SHA512 |
number |
HMAC_SHA512 value |
HMAC_SHA224 |
number |
HMAC_SHA224 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 |
GENERATION_FAILED |
number |
GENERATION_FAILED value |
PENDING_EXTERNAL_DESTRUCTION |
number |
PENDING_EXTERNAL_DESTRUCTION value |
EXTERNAL_DESTRUCTION_FAILED |
number |
EXTERNAL_DESTRUCTION_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 |
Methods
toJSON() → {Object.<string, *>}
Converts this CryptoKeyVersion to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(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) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for CryptoKeyVersion
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(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 |
|