Package com.google.firestore.admin.v1

Interface ExportDocumentsRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCollectionIds(int index)
    Which collection IDs to export.
    com.google.protobuf.ByteString
    getCollectionIdsBytes(int index)
    Which collection IDs to export.
    int
    getCollectionIdsCount()
    Which collection IDs to export.
    List<String>
    getCollectionIdsList()
    Which collection IDs to export.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    String
    getNamespaceIds(int index)
    An empty list represents all namespaces.
    com.google.protobuf.ByteString
    getNamespaceIdsBytes(int index)
    An empty list represents all namespaces.
    int
    getNamespaceIdsCount()
    An empty list represents all namespaces.
    List<String>
    getNamespaceIdsList()
    An empty list represents all namespaces.
    String
    getOutputUriPrefix()
    The output URI.
    com.google.protobuf.ByteString
    getOutputUriPrefixBytes()
    The output URI.
    com.google.protobuf.Timestamp
    getSnapshotTime()
    The timestamp that corresponds to the version of the database to be exported.
    com.google.protobuf.TimestampOrBuilder
    getSnapshotTimeOrBuilder()
    The timestamp that corresponds to the version of the database to be exported.
    boolean
    hasSnapshotTime()
    The timestamp that corresponds to the version of the database to be exported.

    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

    • getName

      String getName()
       Required. Database to export. Should be of the form:
 `projects/{project_id}/databases/{database_id}`.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. Database to export. Should be of the form:
 `projects/{project_id}/databases/{database_id}`.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for name.

    • getCollectionIdsList

      List<String> getCollectionIdsList()
       Which collection IDs to export. Unspecified means all collections. Each
 collection ID in this list must be unique.
      repeated string collection_ids = 2;
      Returns:
      A list containing the collectionIds.

    • getCollectionIdsCount

      int getCollectionIdsCount()
       Which collection IDs to export. Unspecified means all collections. Each
 collection ID in this list must be unique.
      repeated string collection_ids = 2;
      Returns:
      The count of collectionIds.

    • getCollectionIds

      String getCollectionIds(int index)
       Which collection IDs to export. Unspecified means all collections. Each
 collection ID in this list must be unique.
      repeated string collection_ids = 2;
      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 to export. Unspecified means all collections. Each
 collection ID in this list must be unique.
      repeated string collection_ids = 2;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the collectionIds at the given index.

    • getOutputUriPrefix

      String getOutputUriPrefix()
       The output URI. Currently only supports Google Cloud Storage URIs of the
 form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name
 of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional
 Google Cloud Storage namespace path. When
 choosing a name, be sure to consider Google Cloud Storage naming
 guidelines: https://cloud.google.com/storage/docs/naming.
 If the URI is a bucket (without a namespace path), a prefix will be
 generated based on the start time.
      string output_uri_prefix = 3;
      Returns:
      The outputUriPrefix.

    • getOutputUriPrefixBytes

      com.google.protobuf.ByteString getOutputUriPrefixBytes()
       The output URI. Currently only supports Google Cloud Storage URIs of the
 form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name
 of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional
 Google Cloud Storage namespace path. When
 choosing a name, be sure to consider Google Cloud Storage naming
 guidelines: https://cloud.google.com/storage/docs/naming.
 If the URI is a bucket (without a namespace path), a prefix will be
 generated based on the start time.
      string output_uri_prefix = 3;
      Returns:
      The bytes for outputUriPrefix.

    • getNamespaceIdsList

      List<String> getNamespaceIdsList()
       An empty list represents all namespaces. This is the preferred
 usage for databases that don't use namespaces.

 An empty string element represents the default namespace. This should be
 used if the database has data in non-default namespaces, but doesn't want
 to include them. Each namespace in this list must be unique.
      repeated string namespace_ids = 4;
      Returns:
      A list containing the namespaceIds.

    • getNamespaceIdsCount

      int getNamespaceIdsCount()
       An empty list represents all namespaces. This is the preferred
 usage for databases that don't use namespaces.

 An empty string element represents the default namespace. This should be
 used if the database has data in non-default namespaces, but doesn't want
 to include them. Each namespace in this list must be unique.
      repeated string namespace_ids = 4;
      Returns:
      The count of namespaceIds.

    • getNamespaceIds

      String getNamespaceIds(int index)
       An empty list represents all namespaces. This is the preferred
 usage for databases that don't use namespaces.

 An empty string element represents the default namespace. This should be
 used if the database has data in non-default namespaces, but doesn't want
 to include them. Each namespace in this list must be unique.
      repeated string namespace_ids = 4;
      Parameters:
      index - The index of the element to return.
      Returns:
      The namespaceIds at the given index.

    • getNamespaceIdsBytes

      com.google.protobuf.ByteString getNamespaceIdsBytes(int index)
       An empty list represents all namespaces. This is the preferred
 usage for databases that don't use namespaces.

 An empty string element represents the default namespace. This should be
 used if the database has data in non-default namespaces, but doesn't want
 to include them. Each namespace in this list must be unique.
      repeated string namespace_ids = 4;
      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 to be
 exported. The timestamp must be in the past, rounded to the minute and not
 older than
 [earliestVersionTime][google.firestore.admin.v1.Database.earliest_version_time].
 If specified, then the exported documents will represent a consistent view
 of the database at the provided time. Otherwise, there are no guarantees
 about the consistency of the exported documents.
      .google.protobuf.Timestamp snapshot_time = 5;
      Returns:
      Whether the snapshotTime field is set.

    • getSnapshotTime

      com.google.protobuf.Timestamp getSnapshotTime()
       The timestamp that corresponds to the version of the database to be
 exported. The timestamp must be in the past, rounded to the minute and not
 older than
 [earliestVersionTime][google.firestore.admin.v1.Database.earliest_version_time].
 If specified, then the exported documents will represent a consistent view
 of the database at the provided time. Otherwise, there are no guarantees
 about the consistency of the exported documents.
      .google.protobuf.Timestamp snapshot_time = 5;
      Returns:
      The snapshotTime.

    • getSnapshotTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getSnapshotTimeOrBuilder()
       The timestamp that corresponds to the version of the database to be
 exported. The timestamp must be in the past, rounded to the minute and not
 older than
 [earliestVersionTime][google.firestore.admin.v1.Database.earliest_version_time].
 If specified, then the exported documents will represent a consistent view
 of the database at the provided time. Otherwise, there are no guarantees
 about the consistency of the exported documents.
      .google.protobuf.Timestamp snapshot_time = 5;