Class protos.google.protobuf.FieldMask (0.7.0)
Represents a FieldMask.
Package
@google-shopping/cssConstructors
(constructor)(properties)
constructor(properties?:google.protobuf.IFieldMask);Constructs a new FieldMask.
| Parameter | |
|---|---|
| Name | Description |
properties | IFieldMaskProperties to set |
Properties
paths
publicpaths:string[];FieldMask paths.
Methods
create(properties)
publicstaticcreate(properties?:google.protobuf.IFieldMask):google.protobuf.FieldMask;Creates a new FieldMask instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IFieldMaskProperties to set |
| Returns | |
|---|---|
| Type | Description |
FieldMask | FieldMask instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.protobuf.FieldMask;Decodes a FieldMask message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
FieldMask | FieldMask |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.protobuf.FieldMask;Decodes a FieldMask message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
FieldMask | FieldMask |
encode(message, writer)
publicstaticencode(message:google.protobuf.IFieldMask,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified FieldMask message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IFieldMaskFieldMask message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.protobuf.IFieldMask,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified FieldMask message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IFieldMaskFieldMask message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.protobuf.FieldMask;Creates a FieldMask message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object | { [k: string]: any }Plain object |
| Returns | |
|---|---|
| Type | Description |
FieldMask | FieldMask |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for FieldMask
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this FieldMask to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(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.
| Parameters | |
|---|---|
| Name | Description |
message | FieldMaskFieldMask |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a FieldMask message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.