Constructor
new CryptoKey(propertiesopt)
Constructs a new CryptoKey.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.kms.v1.ICryptoKey |
<optional> |
Properties to set |
- Implements:
-
- ICryptoKey
Members
createTime
CryptoKey createTime.
cryptoKeyBackend
CryptoKey cryptoKeyBackend.
destroyScheduledDuration
CryptoKey destroyScheduledDuration.
importOnly
CryptoKey importOnly.
labels
CryptoKey labels.
name
CryptoKey name.
nextRotationTime
CryptoKey nextRotationTime.
primary
CryptoKey primary.
purpose
CryptoKey purpose.
rotationPeriod
CryptoKey rotationPeriod.
rotationSchedule
CryptoKey rotationSchedule.
versionTemplate
CryptoKey versionTemplate.
CryptoKeyPurpose
CryptoKeyPurpose enum.
Properties:
| Name | Type | Description |
|---|---|---|
CRYPTO_KEY_PURPOSE_UNSPECIFIED |
number |
CRYPTO_KEY_PURPOSE_UNSPECIFIED value |
ENCRYPT_DECRYPT |
number |
ENCRYPT_DECRYPT value |
ASYMMETRIC_SIGN |
number |
ASYMMETRIC_SIGN value |
ASYMMETRIC_DECRYPT |
number |
ASYMMETRIC_DECRYPT value |
MAC |
number |
MAC value |
Methods
toJSON() → {Object.<string, *>}
Converts this CryptoKey to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.kms.v1.CryptoKey}
Creates a new CryptoKey instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.kms.v1.ICryptoKey |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.kms.v1.CryptoKey |
CryptoKey instance |
(static) decode(reader, lengthopt) → {google.cloud.kms.v1.CryptoKey}
Decodes a CryptoKey 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.CryptoKey |
CryptoKey |
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.CryptoKey}
Decodes a CryptoKey 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.CryptoKey |
CryptoKey |
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 CryptoKey message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.kms.v1.ICryptoKey |
CryptoKey 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 CryptoKey message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.kms.v1.ICryptoKey |
CryptoKey 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.CryptoKey}
Creates a CryptoKey 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.CryptoKey |
CryptoKey |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for CryptoKey
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 CryptoKey message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.kms.v1.CryptoKey |
CryptoKey |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a CryptoKey message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|