Represents a CryptoKey.
Package
@google-cloud/kmsConstructors
(constructor)(properties)
constructor(properties?: google.cloud.kms.v1.ICryptoKey);Constructs a new CryptoKey.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICryptoKey
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);CryptoKey createTime.
cryptoKeyBackend
public cryptoKeyBackend: string;CryptoKey cryptoKeyBackend.
destroyScheduledDuration
public destroyScheduledDuration?: (google.protobuf.IDuration|null);CryptoKey destroyScheduledDuration.
importOnly
public importOnly: boolean;CryptoKey importOnly.
labels
public labels: { [k: string]: string };CryptoKey labels.
name
public name: string;CryptoKey name.
nextRotationTime
public nextRotationTime?: (google.protobuf.ITimestamp|null);CryptoKey nextRotationTime.
primary
public primary?: (google.cloud.kms.v1.ICryptoKeyVersion|null);CryptoKey primary.
purpose
public purpose: (google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose|keyof typeof google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose);CryptoKey purpose.
rotationPeriod
public rotationPeriod?: (google.protobuf.IDuration|null);CryptoKey rotationPeriod.
rotationSchedule
public rotationSchedule?: "rotationPeriod";CryptoKey rotationSchedule.
versionTemplate
public versionTemplate?: (google.cloud.kms.v1.ICryptoKeyVersionTemplate|null);CryptoKey versionTemplate.
Methods
create(properties)
public static create(properties?: google.cloud.kms.v1.ICryptoKey): google.cloud.kms.v1.CryptoKey;Creates a new CryptoKey instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICryptoKey
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.kms.v1.CryptoKey | CryptoKey instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.kms.v1.CryptoKey;Decodes a CryptoKey message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.cloud.kms.v1.CryptoKey | CryptoKey |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.kms.v1.CryptoKey;Decodes a CryptoKey message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.cloud.kms.v1.CryptoKey | CryptoKey |
encode(message, writer)
public static encode(message: google.cloud.kms.v1.ICryptoKey, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CryptoKey message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICryptoKey
CryptoKey message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.kms.v1.ICryptoKey, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CryptoKey message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICryptoKey
CryptoKey message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.kms.v1.CryptoKey;Creates a CryptoKey message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
google.cloud.kms.v1.CryptoKey | CryptoKey |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for CryptoKey
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this CryptoKey to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.kms.v1.CryptoKey, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a CryptoKey message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.cloud.kms.v1.CryptoKey
CryptoKey |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a CryptoKey message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|