Package com.google.firestore.admin.v1

Class ExportDocumentsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.firestore.admin.v1.ExportDocumentsRequest
All Implemented Interfaces:
ExportDocumentsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ExportDocumentsRequest extends com.google.protobuf.GeneratedMessage implements ExportDocumentsRequestOrBuilder
 The request for
 [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
Protobuf type google.firestore.admin.v1.ExportDocumentsRequest
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • COLLECTION_IDS_FIELD_NUMBER

      public static final int COLLECTION_IDS_FIELD_NUMBER
      See Also:

    • OUTPUT_URI_PREFIX_FIELD_NUMBER

      public static final int OUTPUT_URI_PREFIX_FIELD_NUMBER
      See Also:

    • NAMESPACE_IDS_FIELD_NUMBER

      public static final int NAMESPACE_IDS_FIELD_NUMBER
      See Also:

    • SNAPSHOT_TIME_FIELD_NUMBER

      public static final int SNAPSHOT_TIME_FIELD_NUMBER
      See Also:

  • 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

    • getName

      public 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) = { ... }
      Specified by:
      getName in interface ExportDocumentsRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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) = { ... }
      Specified by:
      getNameBytes in interface ExportDocumentsRequestOrBuilder
      Returns:
      The bytes for name.

    • getCollectionIdsList

      public com.google.protobuf.ProtocolStringList getCollectionIdsList()
       IDs of the collection groups to export. Unspecified means all
 collection groups. Each collection group in this list must be unique.
      repeated string collection_ids = 2;
      Specified by:
      getCollectionIdsList in interface ExportDocumentsRequestOrBuilder
      Returns:
      A list containing the collectionIds.

    • getCollectionIdsCount

      public int getCollectionIdsCount()
       IDs of the collection groups to export. Unspecified means all
 collection groups. Each collection group in this list must be unique.
      repeated string collection_ids = 2;
      Specified by:
      getCollectionIdsCount in interface ExportDocumentsRequestOrBuilder
      Returns:
      The count of collectionIds.

    • getCollectionIds

      public String getCollectionIds(int index)
       IDs of the collection groups to export. Unspecified means all
 collection groups. Each collection group in this list must be unique.
      repeated string collection_ids = 2;
      Specified by:
      getCollectionIds in interface ExportDocumentsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The collectionIds at the given index.

    • getCollectionIdsBytes

      public com.google.protobuf.ByteString getCollectionIdsBytes(int index)
       IDs of the collection groups to export. Unspecified means all
 collection groups. Each collection group in this list must be unique.
      repeated string collection_ids = 2;
      Specified by:
      getCollectionIdsBytes in interface ExportDocumentsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the collectionIds at the given index.

    • getOutputUriPrefix

      public 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;
      Specified by:
      getOutputUriPrefix in interface ExportDocumentsRequestOrBuilder
      Returns:
      The outputUriPrefix.

    • getOutputUriPrefixBytes

      public 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;
      Specified by:
      getOutputUriPrefixBytes in interface ExportDocumentsRequestOrBuilder
      Returns:
      The bytes for outputUriPrefix.

    • getNamespaceIdsList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getNamespaceIdsList in interface ExportDocumentsRequestOrBuilder
      Returns:
      A list containing the namespaceIds.

    • getNamespaceIdsCount

      public 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;
      Specified by:
      getNamespaceIdsCount in interface ExportDocumentsRequestOrBuilder
      Returns:
      The count of namespaceIds.

    • getNamespaceIds

      public 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;
      Specified by:
      getNamespaceIds in interface ExportDocumentsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The namespaceIds at the given index.

    • getNamespaceIdsBytes

      public 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;
      Specified by:
      getNamespaceIdsBytes in interface ExportDocumentsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the namespaceIds at the given index.

    • hasSnapshotTime

      public 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;
      Specified by:
      hasSnapshotTime in interface ExportDocumentsRequestOrBuilder
      Returns:
      Whether the snapshotTime field is set.

    • getSnapshotTime

      public 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;
      Specified by:
      getSnapshotTime in interface ExportDocumentsRequestOrBuilder
      Returns:
      The snapshotTime.

    • getSnapshotTimeOrBuilder

      public 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;
      Specified by:
      getSnapshotTimeOrBuilder in interface ExportDocumentsRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ExportDocumentsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDocumentsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDocumentsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDocumentsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDocumentsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDocumentsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDocumentsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExportDocumentsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExportDocumentsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExportDocumentsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExportDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExportDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ExportDocumentsRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ExportDocumentsRequest.Builder newBuilder()

    • newBuilder

      public static ExportDocumentsRequest.Builder newBuilder(ExportDocumentsRequest prototype)

    • toBuilder

      public ExportDocumentsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ExportDocumentsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ExportDocumentsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ExportDocumentsRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ExportDocumentsRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ExportDocumentsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder