Represents a CryptoKey.
Package
@google-cloud/dlpConstructors
(constructor)(properties)
constructor
(
properties
?:
google
.
privacy
.
dlp
.
v2
.
ICryptoKey
);
Constructs a new CryptoKey.
| Name | Description |
| properties | ICryptoKey
Properties to set |
Properties
kmsWrapped
public
kmsWrapped
?:
(
google
.
privacy
.
dlp
.
v2
.
IKmsWrappedCryptoKey
|
null
);
CryptoKey kmsWrapped.
source
public
source
?:
(
"transient"
|
"unwrapped"
|
"kmsWrapped"
);
CryptoKey source.
transient
public
transient
?:
(
google
.
privacy
.
dlp
.
v2
.
ITransientCryptoKey
|
null
);
CryptoKey transient.
unwrapped
public
unwrapped
?:
(
google
.
privacy
.
dlp
.
v2
.
IUnwrappedCryptoKey
|
null
);
CryptoKey unwrapped.
Methods
create(properties)
public
static
create
(
properties
?:
google
.
privacy
.
dlp
.
v2
.
ICryptoKey
)
:
google
.
privacy
.
dlp
.
v2
.
CryptoKey
;
Creates a new CryptoKey instance using the specified properties.
| Name | Description |
| properties | ICryptoKey
Properties to set |
| Type | Description |
|---|---|
| google.privacy.dlp.v2.CryptoKey | CryptoKey instance |
decode(reader, length)
public
static
decode
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
),
length
?:
number
)
:
google
.
privacy
.
dlp
.
v2
.
CryptoKey
;
Decodes a CryptoKey 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.privacy.dlp.v2.CryptoKey | CryptoKey |
decodeDelimited(reader)
public
static
decodeDelimited
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
))
:
google
.
privacy
.
dlp
.
v2
.
CryptoKey
;
Decodes a CryptoKey message from the specified reader or buffer, length delimited.
| Name | Description |
| reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
| Type | Description |
|---|---|
| google.privacy.dlp.v2.CryptoKey | CryptoKey |
encode(message, writer)
public
static
encode
(
message
:
google
.
privacy
.
dlp
.
v2
.
ICryptoKey
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified CryptoKey message. Does not implicitly messages.
| Name | Description |
| message | ICryptoKey
CryptoKey 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
.
privacy
.
dlp
.
v2
.
ICryptoKey
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified CryptoKey message, length delimited. Does not implicitly messages.
| Name | Description |
| message | ICryptoKey
CryptoKey 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
.
privacy
.
dlp
.
v2
.
CryptoKey
;
Creates a CryptoKey message from a plain object. Also converts values to their respective internal types.
| Name | Description |
| object | { [k: string]: any }
Plain object |
| Type | Description |
|---|---|
| google.privacy.dlp.v2.CryptoKey | CryptoKey |
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this CryptoKey to JSON.
| Type | Description |
|---|---|
| { [k: string]: any } | JSON object |
toObject(message, options)
public
static
toObject
(
message
:
google
.
privacy
.
dlp
.
v2
.
CryptoKey
,
options
?:
$protobuf
.
IConversionOptions
)
:
{
[
k
:
string
]
:
any
};
Creates a plain object from a CryptoKey message. Also converts values to other types if specified.
| Name | Description |
| message | google.privacy.dlp.v2.CryptoKey
CryptoKey |
| 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 CryptoKey message.
| Name | Description |
| message | { [k: string]: any }
Plain object to verify |
| Type | Description |
| (string|null) | |
