Package com.google.firestore.v1

Interface DocumentMaskOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DocumentMask, DocumentMask.Builder
public interface DocumentMaskOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    List<String>
    getFieldPathsList()
    The list of field paths in the mask.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getFieldPathsList

      List<String> 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;
      Returns:
      A list containing the fieldPaths.

    • getFieldPathsCount

      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;
      Returns:
      The count of fieldPaths.

    • getFieldPaths

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The fieldPaths at the given index.

    • getFieldPathsBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the fieldPaths at the given index.