Package com.google.firestore.admin.v1

Class ExportDocumentsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ExportDocumentsRequest.Builder>
com.google.firestore.admin.v1.ExportDocumentsRequest.Builder
All Implemented Interfaces:
ExportDocumentsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ExportDocumentsRequest
public static final class ExportDocumentsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ExportDocumentsRequest.Builder> implements ExportDocumentsRequestOrBuilder
 The request for
 [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
Protobuf type google.firestore.admin.v1.ExportDocumentsRequest

  • 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.Builder<ExportDocumentsRequest.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ExportDocumentsRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ExportDocumentsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportDocumentsRequest.Builder>

    • mergeFrom

      public ExportDocumentsRequest.Builder mergeFrom(ExportDocumentsRequest other)

    • isInitialized

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

    • mergeFrom

      public ExportDocumentsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportDocumentsRequest.Builder>
      Throws:
      IOException

    • 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.

    • setName

      public ExportDocumentsRequest.Builder setName(String value)
       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) = { ... }
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public ExportDocumentsRequest.Builder clearName()
       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:
      This builder for chaining.

    • setNameBytes

      public ExportDocumentsRequest.Builder setNameBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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.

    • setCollectionIds

      public ExportDocumentsRequest.Builder setCollectionIds(int index, String value)
       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;
      Parameters:
      index - The index to set the value at.
      value - The collectionIds to set.
      Returns:
      This builder for chaining.

    • addCollectionIds

      public ExportDocumentsRequest.Builder addCollectionIds(String value)
       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;
      Parameters:
      value - The collectionIds to add.
      Returns:
      This builder for chaining.

    • addAllCollectionIds

      public ExportDocumentsRequest.Builder addAllCollectionIds(Iterable<String> values)
       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;
      Parameters:
      values - The collectionIds to add.
      Returns:
      This builder for chaining.

    • clearCollectionIds

      public ExportDocumentsRequest.Builder clearCollectionIds()
       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;
      Returns:
      This builder for chaining.

    • addCollectionIdsBytes

      public ExportDocumentsRequest.Builder addCollectionIdsBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes of the collectionIds to add.
      Returns:
      This builder for chaining.

    • 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.

    • setOutputUriPrefix

      public ExportDocumentsRequest.Builder setOutputUriPrefix(String value)
       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;
      Parameters:
      value - The outputUriPrefix to set.
      Returns:
      This builder for chaining.

    • clearOutputUriPrefix

      public ExportDocumentsRequest.Builder clearOutputUriPrefix()
       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:
      This builder for chaining.

    • setOutputUriPrefixBytes

      public ExportDocumentsRequest.Builder setOutputUriPrefixBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for outputUriPrefix to set.
      Returns:
      This builder for chaining.

    • 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.

    • setNamespaceIds

      public ExportDocumentsRequest.Builder setNamespaceIds(int index, String value)
       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 to set the value at.
      value - The namespaceIds to set.
      Returns:
      This builder for chaining.

    • addNamespaceIds

      public ExportDocumentsRequest.Builder addNamespaceIds(String value)
       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:
      value - The namespaceIds to add.
      Returns:
      This builder for chaining.

    • addAllNamespaceIds

      public ExportDocumentsRequest.Builder addAllNamespaceIds(Iterable<String> values)
       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:
      values - The namespaceIds to add.
      Returns:
      This builder for chaining.

    • clearNamespaceIds

      public ExportDocumentsRequest.Builder clearNamespaceIds()
       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:
      This builder for chaining.

    • addNamespaceIdsBytes

      public ExportDocumentsRequest.Builder addNamespaceIdsBytes(com.google.protobuf.ByteString value)
       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:
      value - The bytes of the namespaceIds to add.
      Returns:
      This builder for chaining.

    • 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.

    • setSnapshotTime

      public ExportDocumentsRequest.Builder setSnapshotTime(com.google.protobuf.Timestamp value)
       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;

    • setSnapshotTime

      public ExportDocumentsRequest.Builder setSnapshotTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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;

    • mergeSnapshotTime

      public ExportDocumentsRequest.Builder mergeSnapshotTime(com.google.protobuf.Timestamp value)
       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;

    • clearSnapshotTime

      public ExportDocumentsRequest.Builder clearSnapshotTime()
       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;

    • getSnapshotTimeBuilder

      public com.google.protobuf.Timestamp.Builder getSnapshotTimeBuilder()
       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;

    • 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