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