Represents a FieldMask.
Package
@google-cloud/kms!Constructors
(constructor)(properties)
constructor
(
properties
?:
google
.
protobuf
.
IFieldMask
);
Constructs a new FieldMask.
| Type | Name | Description |
|---|---|---|
|
IFieldMask
|
properties | Properties to set |
Properties
paths
public
paths
:
string
[];
FieldMask paths.
| Type | Description |
|---|---|
| string[] |
Methods
create(properties)
public
static
create
(
properties
?:
google
.
protobuf
.
IFieldMask
)
:
google
.
protobuf
.
FieldMask
;
Creates a new FieldMask instance using the specified properties.
| Type | Name | Description |
|---|---|---|
|
IFieldMask
|
properties | Properties to set |
| Type | Description |
|---|---|
| google.protobuf.FieldMask | FieldMask instance |
decode(reader, length)
public
static
decode
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
),
length
?:
number
)
:
google
.
protobuf
.
FieldMask
;
Decodes a FieldMask message from the specified reader or buffer.
| Type | Name | Description |
|---|---|---|
|
($protobuf. Reader
| Uint8Array
)
|
reader | Reader or buffer to decode from |
|
number
|
length | Message length if known beforehand |
| Type | Description |
|---|---|
| google.protobuf.FieldMask | FieldMask |
decodeDelimited(reader)
public
static
decodeDelimited
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
))
:
google
.
protobuf
.
FieldMask
;
Decodes a FieldMask message from the specified reader or buffer, length delimited.
| Type | Name | Description |
|---|---|---|
|
($protobuf. Reader
| Uint8Array
)
|
reader | Reader or buffer to decode from |
| Type | Description |
|---|---|
| google.protobuf.FieldMask | FieldMask |
encode(message, writer)
public
static
encode
(
message
:
google
.
protobuf
.
IFieldMask
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified FieldMask message. Does not implicitly messages.
| Type | Name | Description |
|---|---|---|
|
IFieldMask
|
message | FieldMask message or plain object to encode |
|
$protobuf. Writer
|
writer | Writer to encode to |
| Type | Description |
|---|---|
| $protobuf. Writer | Writer |
encodeDelimited(message, writer)
public
static
encodeDelimited
(
message
:
google
.
protobuf
.
IFieldMask
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified FieldMask message, length delimited. Does not implicitly messages.
| Type | Name | Description |
|---|---|---|
|
IFieldMask
|
message | FieldMask message or plain object to encode |
|
$protobuf. Writer
|
writer | Writer to encode to |
| Type | Description |
|---|---|
| $protobuf. Writer | Writer |
fromObject(object)
public
static
fromObject
(
object
:
{
[
k
:
string
]
:
any
})
:
google
.
protobuf
.
FieldMask
;
Creates a FieldMask message from a plain object. Also converts values to their respective internal types.
| Type | Name | Description |
|---|---|---|
|
{ [k: string]: any }
|
object | Plain object |
| Type | Description |
|---|---|
| google.protobuf.FieldMask | FieldMask |
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this FieldMask to JSON.
| Type | Description |
|---|---|
| { [k: string]: any } | JSON object |
toObject(message, options)
public
static
toObject
(
message
:
google
.
protobuf
.
FieldMask
,
options
?:
$protobuf
.
IConversionOptions
)
:
{
[
k
:
string
]
:
any
};
Creates a plain object from a FieldMask message. Also converts values to other types if specified.
| Type | Name | Description |
|---|---|---|
|
google.protobuf.FieldMask
|
message | FieldMask |
|
$protobuf. IConversionOptions
|
options | Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public
static
verify
(
message
:
{
[
k
:
string
]
:
any
})
:
(
string
|
null
);
Verifies a FieldMask message.
| Type | Name | Description |
|---|---|---|
|
{ [k: string]: any }
|
message | Plain object to verify |
| Type | Description |
|---|---|
| (string|null) | |
