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
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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;
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;
| Name | Description |
| value | String
The fieldPaths to add.
|
Returns
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;
| Name | Description |
| value | ByteString
The bytes of the fieldPaths to add.
|
Returns
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DocumentMask.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public DocumentMask build()
Returns
buildPartial()
public DocumentMask buildPartial()
Returns
clear()
public DocumentMask.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public DocumentMask.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
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)
Parameter
Returns
Overrides
clone()
public DocumentMask.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public DocumentMask getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
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;
| Name | Description |
| index | int
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;
| Name | Description |
| index | int
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;
| 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()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(DocumentMask other)
public DocumentMask.Builder mergeFrom(DocumentMask other)
Parameter
Returns
public DocumentMask.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public DocumentMask.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DocumentMask.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public DocumentMask.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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;
| Name | Description |
| index | int
The index to set the value at.
|
| value | String
The fieldPaths to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DocumentMask.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final DocumentMask.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
