DocumentMask.Builder (Google Cloud Firestore Parent 3.13.2 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>
    - - com.google.firestore.v1.DocumentMask.Builder

All Implemented Interfaces:: DocumentMaskOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:: DocumentMask

public static final class DocumentMask.Builder
extends com.google.protobuf.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.v1.Document], and takes in account the dynamic
 nature of [Value][google.firestore.v1.Value].

Protobuf type google.firestore.v1.DocumentMask

Method Summary

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

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

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

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>
  - clear
```
public DocumentMask.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>
  - getDefaultInstanceForType
```
public DocumentMask getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public DocumentMask build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public DocumentMask buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public DocumentMask.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>
  - setField
```
public DocumentMask.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>
  - clearField
```
public DocumentMask.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>
  - clearOneof
```
public DocumentMask.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>
  - setRepeatedField
```
public DocumentMask.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             int index,
                                             Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>
  - addRepeatedField
```
public DocumentMask.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>
  - mergeFrom
```
public DocumentMask.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DocumentMask.Builder>
  - mergeFrom
```
public DocumentMask.Builder mergeFrom(DocumentMask other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>
  - mergeFrom
```
public DocumentMask.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DocumentMask.Builder>
    
    Throws:
    
    IOException
  - getFieldPathsList
```
public com.google.protobuf.ProtocolStringList getFieldPathsList()
```
```
 The list of field paths in the mask. See
 [Document.fields][google.firestore.v1.Document.fields] for a field path
 syntax reference.
 
```
    repeated string field_paths = 1;
    Specified by:
    
    getFieldPathsList in interface DocumentMaskOrBuilder
    
    Returns:
    
    A list containing the fieldPaths.
  - getFieldPathsCount
```
public int getFieldPathsCount()
```
```
 The list of field paths in the mask. See
 [Document.fields][google.firestore.v1.Document.fields] for a field path
 syntax reference.
 
```
    repeated string field_paths = 1;
    Specified by:
    
    getFieldPathsCount in interface DocumentMaskOrBuilder
    
    Returns:
    
    The count of fieldPaths.
  - getFieldPaths
```
public String getFieldPaths(int index)
```
```
 The list of field paths in the mask. See
 [Document.fields][google.firestore.v1.Document.fields] for a field path
 syntax reference.
 
```
    repeated string field_paths = 1;
    Specified by:
    
    getFieldPaths in interface DocumentMaskOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The fieldPaths at the given index.
  - getFieldPathsBytes
```
public com.google.protobuf.ByteString getFieldPathsBytes(int index)
```
```
 The list of field paths in the mask. See
 [Document.fields][google.firestore.v1.Document.fields] for a field path
 syntax reference.
 
```
    repeated string field_paths = 1;
    Specified by:
    
    getFieldPathsBytes in interface DocumentMaskOrBuilder
    
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the fieldPaths at the given index.
  - setFieldPaths
```
public DocumentMask.Builder setFieldPaths(int index,
                                          String value)
```
```
 The list of field paths in the mask. See
 [Document.fields][google.firestore.v1.Document.fields] for a field path
 syntax reference.
 
```
    repeated string field_paths = 1;
    Parameters:
    
    index - The index to set the value at.
    
    value - The fieldPaths to set.
    
    Returns:
    
    This builder for chaining.
  - addFieldPaths
```
public DocumentMask.Builder addFieldPaths(String value)
```
```
 The list of field paths in the mask. See
 [Document.fields][google.firestore.v1.Document.fields] for a field path
 syntax reference.
 
```
    repeated string field_paths = 1;
    Parameters:
    
    value - The fieldPaths to add.
    
    Returns:
    
    This builder for chaining.
  - addAllFieldPaths
```
public DocumentMask.Builder addAllFieldPaths(Iterable<String> values)
```
```
 The list of field paths in the mask. See
 [Document.fields][google.firestore.v1.Document.fields] for a field path
 syntax reference.
 
```
    repeated string field_paths = 1;
    Parameters:
    
    values - The fieldPaths to add.
    
    Returns:
    
    This builder for chaining.
  - clearFieldPaths
```
public DocumentMask.Builder clearFieldPaths()
```
```
 The list of field paths in the mask. See
 [Document.fields][google.firestore.v1.Document.fields] for a field path
 syntax reference.
 
```
    repeated string field_paths = 1;
    Returns:
    
    This builder for chaining.
  - addFieldPathsBytes
```
public DocumentMask.Builder addFieldPathsBytes(com.google.protobuf.ByteString value)
```
```
 The list of field paths in the mask. See
 [Document.fields][google.firestore.v1.Document.fields] for a field path
 syntax reference.
 
```
    repeated string field_paths = 1;
    Parameters:
    
    value - The bytes of the fieldPaths to add.
    
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final DocumentMask.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>
  - mergeUnknownFields
```
public final DocumentMask.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentMask.Builder>

Class DocumentMask.Builder

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getFieldPathsList

getFieldPathsCount

getFieldPaths

getFieldPathsBytes

setFieldPaths

addFieldPaths

addAllFieldPaths

clearFieldPaths

addFieldPathsBytes

setUnknownFields

mergeUnknownFields