public static final class DocumentMask.Builder extends GeneratedMessage.Builder<DocumentMask.Builder> implements DocumentMaskOrBuilderA 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
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > DocumentMask.BuilderImplements
DocumentMaskOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
values |
Iterable<String>The fieldPaths to add. |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder |
This builder for chaining. |
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 |
value |
StringThe fieldPaths to add. |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder |
This builder for chaining. |
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 |
value |
ByteStringThe bytes of the fieldPaths to add. |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder |
This builder for chaining. |
build()
public DocumentMask build()| Returns | |
|---|---|
| Type | Description |
DocumentMask |
|
buildPartial()
public DocumentMask buildPartial()| Returns | |
|---|---|
| Type | Description |
DocumentMask |
|
clear()
public DocumentMask.Builder clear()| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public DocumentMask getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DocumentMask |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
index |
intThe 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 |
index |
intThe 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the fieldPaths. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(DocumentMask other)
public DocumentMask.Builder mergeFrom(DocumentMask other)| Parameter | |
|---|---|
| Name | Description |
other |
DocumentMask |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DocumentMask.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DocumentMask.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder |
|
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 |
index |
intThe index to set the value at. |
value |
StringThe fieldPaths to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder |
This builder for chaining. |