Represents a PublicKey.
Package
@google-cloud/kmsConstructors
(constructor)(properties)
constructor
(
properties
?:
google
.
cloud
.
kms
.
v1
.
IPublicKey
);
Constructs a new PublicKey.
| Name | Description |
| properties | IPublicKey
Properties to set |
Properties
algorithm
public
algorithm
:
(
google
.
cloud
.
kms
.
v1
.
CryptoKeyVersion
.
CryptoKeyVersionAlgorithm
|
keyof
typeof
google
.
cloud
.
kms
.
v1
.
CryptoKeyVersion
.
CryptoKeyVersionAlgorithm
);
PublicKey algorithm.
name
public
name
:
string
;
PublicKey name.
pem
public
pem
:
string
;
PublicKey pem.
pemCrc32c
public
pemCrc32c
?:
(
google
.
protobuf
.
IInt64Value
|
null
);
PublicKey pemCrc32c.
protectionLevel
public
protectionLevel
:
(
google
.
cloud
.
kms
.
v1
.
ProtectionLevel
|
keyof
typeof
google
.
cloud
.
kms
.
v1
.
ProtectionLevel
);
PublicKey protectionLevel.
Methods
create(properties)
public
static
create
(
properties
?:
google
.
cloud
.
kms
.
v1
.
IPublicKey
)
:
google
.
cloud
.
kms
.
v1
.
PublicKey
;
Creates a new PublicKey instance using the specified properties.
| Name | Description |
| properties | IPublicKey
Properties to set |
| Type | Description |
|---|---|
| google.cloud.kms.v1.PublicKey | PublicKey instance |
decode(reader, length)
public
static
decode
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
),
length
?:
number
)
:
google
.
cloud
.
kms
.
v1
.
PublicKey
;
Decodes a PublicKey message from the specified reader or buffer.
| Name | Description |
| reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
| length | number
Message length if known beforehand |
| Type | Description |
|---|---|
| google.cloud.kms.v1.PublicKey | PublicKey |
decodeDelimited(reader)
public
static
decodeDelimited
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
))
:
google
.
cloud
.
kms
.
v1
.
PublicKey
;
Decodes a PublicKey message from the specified reader or buffer, length delimited.
| Name | Description |
| reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
| Type | Description |
|---|---|
| google.cloud.kms.v1.PublicKey | PublicKey |
encode(message, writer)
public
static
encode
(
message
:
google
.
cloud
.
kms
.
v1
.
IPublicKey
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified PublicKey message. Does not implicitly messages.
| Name | Description |
| message | IPublicKey
PublicKey message or plain object to encode |
| writer | $protobuf. Writer
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf. Writer | Writer |
encodeDelimited(message, writer)
public
static
encodeDelimited
(
message
:
google
.
cloud
.
kms
.
v1
.
IPublicKey
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified PublicKey message, length delimited. Does not implicitly messages.
| Name | Description |
| message | IPublicKey
PublicKey message or plain object to encode |
| writer | $protobuf. Writer
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf. Writer | Writer |
fromObject(object)
public
static
fromObject
(
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.
| Name | Description |
| object | { [k: string]: any }
Plain object |
| Type | Description |
|---|---|
| google.cloud.kms.v1.PublicKey | PublicKey |
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this PublicKey to JSON.
| Type | Description |
|---|---|
| { [k: string]: any } | JSON object |
toObject(message, options)
public
static
toObject
(
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.
| Name | Description |
| message | google.cloud.kms.v1.PublicKey
PublicKey |
| options | $protobuf. IConversionOptions
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public
static
verify
(
message
:
{
[
k
:
string
]
:
any
})
:
(
string
|
null
);
Verifies a PublicKey message.
| Name | Description |
| message | { [k: string]: any }
Plain object to verify |
| Type | Description |
| (string|null) | |
