com.google.firestore.v1beta1

Class DocumentMask.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>

com.google.firestore.v1beta1.DocumentMask.Builder

All Implemented Interfaces:

DocumentMaskOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:

DocumentMask

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][google.firestore.v1beta1.Document], and takes in account the dynamic nature of [Value][google.firestore.v1beta1.Value].
 

Protobuf type google.firestore.v1beta1.DocumentMask

Method Summary

Modifier and Type	Method and Description
DocumentMask.Builder	addAllFieldPaths(java.lang.Iterable<java.lang.String> values) The list of field paths in the mask.
DocumentMask.Builder	addFieldPaths(java.lang.String value) The list of field paths in the mask.
DocumentMask.Builder	addFieldPathsBytes(ByteString value) The list of field paths in the mask.
DocumentMask.Builder	addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
DocumentMask	build()
DocumentMask	buildPartial()
DocumentMask.Builder	clear()
DocumentMask.Builder	clearField(Descriptors.FieldDescriptor field)
DocumentMask.Builder	clearFieldPaths() The list of field paths in the mask.
DocumentMask.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
DocumentMask.Builder	clone()
DocumentMask	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
java.lang.String	getFieldPaths(int index) The list of field paths in the mask.
ByteString	getFieldPathsBytes(int index) The list of field paths in the mask.
int	getFieldPathsCount() The list of field paths in the mask.
ProtocolStringList	getFieldPathsList() The list of field paths in the mask.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
DocumentMask.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
DocumentMask.Builder	mergeFrom(DocumentMask other)
DocumentMask.Builder	mergeFrom(Message other)
DocumentMask.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
DocumentMask.Builder	setField(Descriptors.FieldDescriptor field, java.lang.Object value)
DocumentMask.Builder	setFieldPaths(int index, java.lang.String value) The list of field paths in the mask.
DocumentMask.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
DocumentMask.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<DocumentMask.Builder>

clear

public DocumentMask.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<DocumentMask.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<DocumentMask.Builder>

getDefaultInstanceForType

public DocumentMask getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public DocumentMask build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public DocumentMask buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public DocumentMask.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<DocumentMask.Builder>

setField

public DocumentMask.Builder setField(Descriptors.FieldDescriptor field,
                                     java.lang.Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<DocumentMask.Builder>

clearField

public DocumentMask.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<DocumentMask.Builder>

clearOneof

public DocumentMask.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<DocumentMask.Builder>

setRepeatedField

public DocumentMask.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                             int index,
                                             java.lang.Object value)

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<DocumentMask.Builder>

addRepeatedField

public DocumentMask.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                             java.lang.Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<DocumentMask.Builder>

mergeFrom

public DocumentMask.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<DocumentMask.Builder>

mergeFrom

public DocumentMask.Builder mergeFrom(DocumentMask other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<DocumentMask.Builder>

mergeFrom

public DocumentMask.Builder mergeFrom(CodedInputStream input,
                                      ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<DocumentMask.Builder>

Throws:

java.io.IOException

getFieldPathsList

public ProtocolStringList getFieldPathsList()

 The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
 path syntax reference.
 

repeated string field_paths = 1;

Specified by:

getFieldPathsList in interface DocumentMaskOrBuilder

getFieldPathsCount

public int getFieldPathsCount()

 The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
 path syntax reference.
 

repeated string field_paths = 1;

Specified by:

getFieldPathsCount in interface DocumentMaskOrBuilder

getFieldPaths

public java.lang.String getFieldPaths(int index)

 The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
 path syntax reference.
 

repeated string field_paths = 1;

Specified by:

getFieldPaths in interface DocumentMaskOrBuilder

getFieldPathsBytes

public ByteString getFieldPathsBytes(int index)

 The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
 path syntax reference.
 

repeated string field_paths = 1;

Specified by:

getFieldPathsBytes in interface DocumentMaskOrBuilder

setFieldPaths

public DocumentMask.Builder setFieldPaths(int index,
                                          java.lang.String value)

 The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
 path syntax reference.
 

repeated string field_paths = 1;

addFieldPaths

public DocumentMask.Builder addFieldPaths(java.lang.String value)

 The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
 path syntax reference.
 

repeated string field_paths = 1;

addAllFieldPaths

public DocumentMask.Builder addAllFieldPaths(java.lang.Iterable<java.lang.String> values)

 The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
 path syntax reference.
 

repeated string field_paths = 1;

clearFieldPaths

public DocumentMask.Builder clearFieldPaths()

 The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
 path syntax reference.
 

repeated string field_paths = 1;

addFieldPathsBytes

public DocumentMask.Builder addFieldPathsBytes(ByteString value)

 The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
 path syntax reference.
 

repeated string field_paths = 1;

setUnknownFields

public final DocumentMask.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<DocumentMask.Builder>

mergeUnknownFields

public final DocumentMask.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<DocumentMask.Builder>