Class protos.google.cloud.kms.v1.PublicKey (4.5.0)
Represents a PublicKey.
Package
@google-cloud/kmsConstructors
(constructor)(properties)
constructor(properties?:google.cloud.kms.v1.IPublicKey);Constructs a new PublicKey.
| Parameter | |
|---|---|
| Name | Description |
properties | IPublicKeyProperties to set |
Properties
algorithm
publicalgorithm:(google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm|keyoftypeofgoogle.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm);PublicKey algorithm.
name
publicname:string;PublicKey name.
pem
publicpem:string;PublicKey pem.
pemCrc32c
publicpemCrc32c?:(google.protobuf.IInt64Value|null);PublicKey pemCrc32c.
protectionLevel
publicprotectionLevel:(google.cloud.kms.v1.ProtectionLevel|keyoftypeofgoogle.cloud.kms.v1.ProtectionLevel);PublicKey protectionLevel.
Methods
create(properties)
publicstaticcreate(properties?:google.cloud.kms.v1.IPublicKey):google.cloud.kms.v1.PublicKey;Creates a new PublicKey instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IPublicKeyProperties to set |
| Returns | |
|---|---|
| Type | Description |
PublicKey | PublicKey instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.cloud.kms.v1.PublicKey;Decodes a PublicKey message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
PublicKey | PublicKey |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.cloud.kms.v1.PublicKey;Decodes a PublicKey message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
PublicKey | PublicKey |
encode(message, writer)
publicstaticencode(message:google.cloud.kms.v1.IPublicKey,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified PublicKey message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IPublicKeyPublicKey message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.cloud.kms.v1.IPublicKey,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified PublicKey message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IPublicKeyPublicKey message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.cloud.kms.v1.PublicKey;Creates a PublicKey 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 |
PublicKey | PublicKey |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for PublicKey
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this PublicKey to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.cloud.kms.v1.PublicKey,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from a PublicKey message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | PublicKeyPublicKey |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a PublicKey message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.