Class DocumentMask.Builder (3.21.4)
Version 3.21.4keyboard_arrow_down
public static final class DocumentMask . Builder extends GeneratedMessageV3 . Builder<DocumentMask . Builder > implements DocumentMaskOrBuilder
A set of field paths on a document.
Used to restrict a get or update operation on a document to a subset of its
fields.
This is different from standard field masks, as this is always scoped to a
Document , and takes in account the dynamic
nature of Value .
Protobuf type google.firestore.v1.DocumentMask
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addAllFieldPaths(Iterable<String> values)
public DocumentMask . Builder addAllFieldPaths ( Iterable<String> values )
The list of field paths in the mask. See
Document.fields for a field path
syntax reference.
repeated string field_paths = 1;
Parameter
Name Description
valuesIterable <String >The fieldPaths to add.
addFieldPaths(String value)
public DocumentMask . Builder addFieldPaths ( String value )
The list of field paths in the mask. See
Document.fields for a field path
syntax reference.
repeated string field_paths = 1;
Parameter
Name Description
valueString The fieldPaths to add.
addFieldPathsBytes(ByteString value)
public DocumentMask . Builder addFieldPathsBytes ( ByteString value )
The list of field paths in the mask. See
Document.fields for a field path
syntax reference.
repeated string field_paths = 1;
Parameter
Name Description
valueByteString The bytes of the fieldPaths to add.
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DocumentMask . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public DocumentMask build ()
buildPartial()
public DocumentMask buildPartial ()
clear()
public DocumentMask . Builder clear ()
Overrides
clearField(Descriptors.FieldDescriptor field)
public DocumentMask . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
clearFieldPaths()
public DocumentMask . Builder clearFieldPaths ()
The list of field paths in the mask. See
Document.fields for a field path
syntax reference.
repeated string field_paths = 1;
clearOneof(Descriptors.OneofDescriptor oneof)
public DocumentMask . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clone()
public DocumentMask . Builder clone ()
Overrides
getDefaultInstanceForType()
public DocumentMask getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
getFieldPaths(int index)
public String getFieldPaths ( int index )
The list of field paths in the mask. See
Document.fields for a field path
syntax reference.
repeated string field_paths = 1;
Parameter
Name Description
indexint The index of the element to return.
Returns
Type Description
String The fieldPaths at the given index.
getFieldPathsBytes(int index)
public ByteString getFieldPathsBytes ( int index )
The list of field paths in the mask. See
Document.fields for a field path
syntax reference.
repeated string field_paths = 1;
Parameter
Name Description
indexint The index of the value to return.
Returns
Type Description
ByteString The bytes of the fieldPaths at the given index.
getFieldPathsCount()
public int getFieldPathsCount ()
The list of field paths in the mask. See
Document.fields for a field path
syntax reference.
repeated string field_paths = 1;
Returns
Type Description
int The count of fieldPaths.
getFieldPathsList()
public ProtocolStringList getFieldPathsList ()
The list of field paths in the mask. See
Document.fields for a field path
syntax reference.
repeated string field_paths = 1;
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(DocumentMask other)
public DocumentMask . Builder mergeFrom ( DocumentMask other )
public DocumentMask . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public DocumentMask . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DocumentMask . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public DocumentMask . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
setFieldPaths(int index, String value)
public DocumentMask . Builder setFieldPaths ( int index , String value )
The list of field paths in the mask. See
Document.fields for a field path
syntax reference.
repeated string field_paths = 1;
Parameters
Name Description
indexint The index to set the value at.
valueString The fieldPaths to set.
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DocumentMask . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final DocumentMask . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
