Package com.google.firestore.v1

Interface Target.DocumentsTargetOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Target.DocumentsTarget, Target.DocumentsTarget.Builder
Enclosing class:
Target
public static interface Target.DocumentsTargetOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDocuments(int index)
    The names of the documents to retrieve.
    com.google.protobuf.ByteString
    getDocumentsBytes(int index)
    The names of the documents to retrieve.
    int
    getDocumentsCount()
    The names of the documents to retrieve.
    List<String>
    getDocumentsList()
    The names of the documents to retrieve.

    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

    • getDocumentsList

      List<String> getDocumentsList()
       The names of the documents to retrieve. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 The request will fail if any of the document is not a child resource of
 the given `database`. Duplicate names will be elided.
      repeated string documents = 2;
      Returns:
      A list containing the documents.

    • getDocumentsCount

      int getDocumentsCount()
       The names of the documents to retrieve. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 The request will fail if any of the document is not a child resource of
 the given `database`. Duplicate names will be elided.
      repeated string documents = 2;
      Returns:
      The count of documents.

    • getDocuments

      String getDocuments(int index)
       The names of the documents to retrieve. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 The request will fail if any of the document is not a child resource of
 the given `database`. Duplicate names will be elided.
      repeated string documents = 2;
      Parameters:
      index - The index of the element to return.
      Returns:
      The documents at the given index.

    • getDocumentsBytes

      com.google.protobuf.ByteString getDocumentsBytes(int index)
       The names of the documents to retrieve. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 The request will fail if any of the document is not a child resource of
 the given `database`. Duplicate names will be elided.
      repeated string documents = 2;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the documents at the given index.