Skip to main content

Class: FieldMask

Represents a FieldMask.

Properties​

paths​

paths: string[]

FieldMask paths.

Methods​

toJSON()​

toJSON(): object

Converts this FieldMask to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): FieldMask & $Properties

Creates a new FieldMask instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

FieldMask & $Properties

FieldMask instance

Call Signature​

static create(properties?): FieldMask

Creates a new FieldMask instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

FieldMask

FieldMask instance

decode()​

static decode(reader, length?): FieldMask & $Properties

Decodes a FieldMask message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

FieldMask & $Properties

FieldMask

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): FieldMask & $Properties

Decodes a FieldMask message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

FieldMask & $Properties

FieldMask

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified FieldMask message. Does not implicitly google.protobuf.FieldMask.verify|verify messages.

Parameters​

message​

$Properties

FieldMask message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified FieldMask message, length delimited. Does not implicitly google.protobuf.FieldMask.verify|verify messages.

Parameters​

message​

$Properties

FieldMask message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): FieldMask

Creates a FieldMask message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

FieldMask

FieldMask

toObject()​

static toObject(message, options?): object

Creates a plain object from a FieldMask message. Also converts values to other types if specified.

Parameters​

message​

FieldMask

FieldMask

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object