Package com.google.firestore.v1

Class DocumentMask.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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

    Modifier and Type
    Method
    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
    build()
     
    DocumentMask
    buildPartial()
     
    DocumentMask.Builder
    clear()
     
    DocumentMask.Builder
    clearFieldPaths()
    The list of field paths in the mask.
    DocumentMask
    getDefaultInstanceForType()
     
    static final 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.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    DocumentMask.Builder
    mergeFrom(DocumentMask other)
     
    DocumentMask.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    DocumentMask.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    DocumentMask.Builder
    setFieldPaths(int index, String value)
    The list of field paths in the mask.

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

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

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

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

    • 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.GeneratedMessage.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.