Package com.google.firestore.admin.v1

Interface ExportDocumentsMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExportDocumentsMetadata, ExportDocumentsMetadata.Builder
@Generated public interface ExportDocumentsMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasStartTime

      boolean hasStartTime()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;
      Returns:
      Whether the startTime field is set.

    • getStartTime

      com.google.protobuf.Timestamp getStartTime()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;

    • hasEndTime

      boolean hasEndTime()
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;
      Returns:
      Whether the endTime field is set.

    • getEndTime

      com.google.protobuf.Timestamp getEndTime()
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;

    • getOperationStateValue

      int getOperationStateValue()
       The state of the export operation.
      .google.firestore.admin.v1.OperationState operation_state = 3;
      Returns:
      The enum numeric value on the wire for operationState.

    • getOperationState

      OperationState getOperationState()
       The state of the export operation.
      .google.firestore.admin.v1.OperationState operation_state = 3;
      Returns:
      The operationState.

    • hasProgressDocuments

      boolean hasProgressDocuments()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;
      Returns:
      Whether the progressDocuments field is set.

    • getProgressDocuments

      Progress getProgressDocuments()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;
      Returns:
      The progressDocuments.

    • getProgressDocumentsOrBuilder

      ProgressOrBuilder getProgressDocumentsOrBuilder()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;

    • hasProgressBytes

      boolean hasProgressBytes()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;
      Returns:
      Whether the progressBytes field is set.

    • getProgressBytes

      Progress getProgressBytes()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;
      Returns:
      The progressBytes.

    • getProgressBytesOrBuilder

      ProgressOrBuilder getProgressBytesOrBuilder()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;

    • getCollectionIdsList

      List<String> getCollectionIdsList()
       Which collection IDs are being exported.
      repeated string collection_ids = 6;
      Returns:
      A list containing the collectionIds.

    • getCollectionIdsCount

      int getCollectionIdsCount()
       Which collection IDs are being exported.
      repeated string collection_ids = 6;
      Returns:
      The count of collectionIds.

    • getCollectionIds

      String getCollectionIds(int index)
       Which collection IDs are being exported.
      repeated string collection_ids = 6;
      Parameters:
      index - The index of the element to return.
      Returns:
      The collectionIds at the given index.

    • getCollectionIdsBytes

      com.google.protobuf.ByteString getCollectionIdsBytes(int index)
       Which collection IDs are being exported.
      repeated string collection_ids = 6;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the collectionIds at the given index.

    • getOutputUriPrefix

      String getOutputUriPrefix()
       Where the documents are being exported to.
      string output_uri_prefix = 7;
      Returns:
      The outputUriPrefix.

    • getOutputUriPrefixBytes

      com.google.protobuf.ByteString getOutputUriPrefixBytes()
       Where the documents are being exported to.
      string output_uri_prefix = 7;
      Returns:
      The bytes for outputUriPrefix.

    • getNamespaceIdsList

      List<String> getNamespaceIdsList()
       Which namespace IDs are being exported.
      repeated string namespace_ids = 8;
      Returns:
      A list containing the namespaceIds.

    • getNamespaceIdsCount

      int getNamespaceIdsCount()
       Which namespace IDs are being exported.
      repeated string namespace_ids = 8;
      Returns:
      The count of namespaceIds.

    • getNamespaceIds

      String getNamespaceIds(int index)
       Which namespace IDs are being exported.
      repeated string namespace_ids = 8;
      Parameters:
      index - The index of the element to return.
      Returns:
      The namespaceIds at the given index.

    • getNamespaceIdsBytes

      com.google.protobuf.ByteString getNamespaceIdsBytes(int index)
       Which namespace IDs are being exported.
      repeated string namespace_ids = 8;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the namespaceIds at the given index.

    • hasSnapshotTime

      boolean hasSnapshotTime()
       The timestamp that corresponds to the version of the database that is being
 exported. If unspecified, there are no guarantees about the consistency of
 the documents being exported.
      .google.protobuf.Timestamp snapshot_time = 9;
      Returns:
      Whether the snapshotTime field is set.

    • getSnapshotTime

      com.google.protobuf.Timestamp getSnapshotTime()
       The timestamp that corresponds to the version of the database that is being
 exported. If unspecified, there are no guarantees about the consistency of
 the documents being exported.
      .google.protobuf.Timestamp snapshot_time = 9;
      Returns:
      The snapshotTime.

    • getSnapshotTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getSnapshotTimeOrBuilder()
       The timestamp that corresponds to the version of the database that is being
 exported. If unspecified, there are no guarantees about the consistency of
 the documents being exported.
      .google.protobuf.Timestamp snapshot_time = 9;