Package com.google.firestore.admin.v1

Class BulkDeleteDocumentsMetadata.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<BulkDeleteDocumentsMetadata.Builder>
com.google.firestore.admin.v1.BulkDeleteDocumentsMetadata.Builder
All Implemented Interfaces:
BulkDeleteDocumentsMetadataOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
BulkDeleteDocumentsMetadata
public static final class BulkDeleteDocumentsMetadata.Builder extends com.google.protobuf.GeneratedMessage.Builder<BulkDeleteDocumentsMetadata.Builder> implements BulkDeleteDocumentsMetadataOrBuilder
 Metadata for [google.longrunning.Operation][google.longrunning.Operation]
 results from
 [FirestoreAdmin.BulkDeleteDocuments][google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocuments].
Protobuf type google.firestore.admin.v1.BulkDeleteDocumentsMetadata

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

    • clear

      public BulkDeleteDocumentsMetadata.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<BulkDeleteDocumentsMetadata.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<BulkDeleteDocumentsMetadata.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public BulkDeleteDocumentsMetadata.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<BulkDeleteDocumentsMetadata.Builder>

    • mergeFrom

      public BulkDeleteDocumentsMetadata.Builder mergeFrom(BulkDeleteDocumentsMetadata other)

    • isInitialized

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

    • mergeFrom

      public BulkDeleteDocumentsMetadata.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<BulkDeleteDocumentsMetadata.Builder>
      Throws:
      IOException

    • hasStartTime

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

    • getStartTime

      public com.google.protobuf.Timestamp getStartTime()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;
      Specified by:
      getStartTime in interface BulkDeleteDocumentsMetadataOrBuilder
      Returns:
      The startTime.

    • setStartTime

      public BulkDeleteDocumentsMetadata.Builder setStartTime(com.google.protobuf.Timestamp value)
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;

    • setStartTime

      public BulkDeleteDocumentsMetadata.Builder setStartTime(com.google.protobuf.Timestamp.Builder builderForValue)
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;

    • mergeStartTime

      public BulkDeleteDocumentsMetadata.Builder mergeStartTime(com.google.protobuf.Timestamp value)
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;

    • clearStartTime

      public BulkDeleteDocumentsMetadata.Builder clearStartTime()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;

    • getStartTimeBuilder

      public com.google.protobuf.Timestamp.Builder getStartTimeBuilder()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;

    • getStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;
      Specified by:
      getStartTimeOrBuilder in interface BulkDeleteDocumentsMetadataOrBuilder

    • hasEndTime

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

    • getEndTime

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

    • setEndTime

      public BulkDeleteDocumentsMetadata.Builder setEndTime(com.google.protobuf.Timestamp value)
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;

    • setEndTime

      public BulkDeleteDocumentsMetadata.Builder setEndTime(com.google.protobuf.Timestamp.Builder builderForValue)
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;

    • mergeEndTime

      public BulkDeleteDocumentsMetadata.Builder mergeEndTime(com.google.protobuf.Timestamp value)
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;

    • clearEndTime

      public BulkDeleteDocumentsMetadata.Builder clearEndTime()
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;

    • getEndTimeBuilder

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

    • getEndTimeOrBuilder

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

    • getOperationStateValue

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

    • setOperationStateValue

      public BulkDeleteDocumentsMetadata.Builder setOperationStateValue(int value)
       The state of the operation.
      .google.firestore.admin.v1.OperationState operation_state = 3;
      Parameters:
      value - The enum numeric value on the wire for operationState to set.
      Returns:
      This builder for chaining.

    • getOperationState

      public OperationState getOperationState()
       The state of the operation.
      .google.firestore.admin.v1.OperationState operation_state = 3;
      Specified by:
      getOperationState in interface BulkDeleteDocumentsMetadataOrBuilder
      Returns:
      The operationState.

    • setOperationState

      public BulkDeleteDocumentsMetadata.Builder setOperationState(OperationState value)
       The state of the operation.
      .google.firestore.admin.v1.OperationState operation_state = 3;
      Parameters:
      value - The operationState to set.
      Returns:
      This builder for chaining.

    • clearOperationState

      public BulkDeleteDocumentsMetadata.Builder clearOperationState()
       The state of the operation.
      .google.firestore.admin.v1.OperationState operation_state = 3;
      Returns:
      This builder for chaining.

    • hasProgressDocuments

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

    • getProgressDocuments

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

    • setProgressDocuments

      public BulkDeleteDocumentsMetadata.Builder setProgressDocuments(Progress value)
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;

    • setProgressDocuments

      public BulkDeleteDocumentsMetadata.Builder setProgressDocuments(Progress.Builder builderForValue)
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;

    • mergeProgressDocuments

      public BulkDeleteDocumentsMetadata.Builder mergeProgressDocuments(Progress value)
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;

    • clearProgressDocuments

      public BulkDeleteDocumentsMetadata.Builder clearProgressDocuments()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;

    • getProgressDocumentsBuilder

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

    • getProgressDocumentsOrBuilder

      public ProgressOrBuilder getProgressDocumentsOrBuilder()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 4;
      Specified by:
      getProgressDocumentsOrBuilder in interface BulkDeleteDocumentsMetadataOrBuilder

    • hasProgressBytes

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

    • getProgressBytes

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

    • setProgressBytes

      public BulkDeleteDocumentsMetadata.Builder setProgressBytes(Progress value)
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;

    • setProgressBytes

      public BulkDeleteDocumentsMetadata.Builder setProgressBytes(Progress.Builder builderForValue)
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;

    • mergeProgressBytes

      public BulkDeleteDocumentsMetadata.Builder mergeProgressBytes(Progress value)
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;

    • clearProgressBytes

      public BulkDeleteDocumentsMetadata.Builder clearProgressBytes()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;

    • getProgressBytesBuilder

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

    • getProgressBytesOrBuilder

      public ProgressOrBuilder getProgressBytesOrBuilder()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 5;
      Specified by:
      getProgressBytesOrBuilder in interface BulkDeleteDocumentsMetadataOrBuilder

    • getCollectionIdsList

      public com.google.protobuf.ProtocolStringList getCollectionIdsList()
       The IDs of the collection groups that are being deleted.
      repeated string collection_ids = 6;
      Specified by:
      getCollectionIdsList in interface BulkDeleteDocumentsMetadataOrBuilder
      Returns:
      A list containing the collectionIds.

    • getCollectionIdsCount

      public int getCollectionIdsCount()
       The IDs of the collection groups that are being deleted.
      repeated string collection_ids = 6;
      Specified by:
      getCollectionIdsCount in interface BulkDeleteDocumentsMetadataOrBuilder
      Returns:
      The count of collectionIds.

    • getCollectionIds

      public String getCollectionIds(int index)
       The IDs of the collection groups that are being deleted.
      repeated string collection_ids = 6;
      Specified by:
      getCollectionIds in interface BulkDeleteDocumentsMetadataOrBuilder
      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)
       The IDs of the collection groups that are being deleted.
      repeated string collection_ids = 6;
      Specified by:
      getCollectionIdsBytes in interface BulkDeleteDocumentsMetadataOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the collectionIds at the given index.

    • setCollectionIds

      public BulkDeleteDocumentsMetadata.Builder setCollectionIds(int index, String value)
       The IDs of the collection groups that are being deleted.
      repeated string collection_ids = 6;
      Parameters:
      index - The index to set the value at.
      value - The collectionIds to set.
      Returns:
      This builder for chaining.

    • addCollectionIds

      public BulkDeleteDocumentsMetadata.Builder addCollectionIds(String value)
       The IDs of the collection groups that are being deleted.
      repeated string collection_ids = 6;
      Parameters:
      value - The collectionIds to add.
      Returns:
      This builder for chaining.

    • addAllCollectionIds

      public BulkDeleteDocumentsMetadata.Builder addAllCollectionIds(Iterable<String> values)
       The IDs of the collection groups that are being deleted.
      repeated string collection_ids = 6;
      Parameters:
      values - The collectionIds to add.
      Returns:
      This builder for chaining.

    • clearCollectionIds

      public BulkDeleteDocumentsMetadata.Builder clearCollectionIds()
       The IDs of the collection groups that are being deleted.
      repeated string collection_ids = 6;
      Returns:
      This builder for chaining.

    • addCollectionIdsBytes

      public BulkDeleteDocumentsMetadata.Builder addCollectionIdsBytes(com.google.protobuf.ByteString value)
       The IDs of the collection groups that are being deleted.
      repeated string collection_ids = 6;
      Parameters:
      value - The bytes of the collectionIds to add.
      Returns:
      This builder for chaining.

    • getNamespaceIdsList

      public com.google.protobuf.ProtocolStringList getNamespaceIdsList()
       Which namespace IDs are being deleted.
      repeated string namespace_ids = 7;
      Specified by:
      getNamespaceIdsList in interface BulkDeleteDocumentsMetadataOrBuilder
      Returns:
      A list containing the namespaceIds.

    • getNamespaceIdsCount

      public int getNamespaceIdsCount()
       Which namespace IDs are being deleted.
      repeated string namespace_ids = 7;
      Specified by:
      getNamespaceIdsCount in interface BulkDeleteDocumentsMetadataOrBuilder
      Returns:
      The count of namespaceIds.

    • getNamespaceIds

      public String getNamespaceIds(int index)
       Which namespace IDs are being deleted.
      repeated string namespace_ids = 7;
      Specified by:
      getNamespaceIds in interface BulkDeleteDocumentsMetadataOrBuilder
      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)
       Which namespace IDs are being deleted.
      repeated string namespace_ids = 7;
      Specified by:
      getNamespaceIdsBytes in interface BulkDeleteDocumentsMetadataOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the namespaceIds at the given index.

    • setNamespaceIds

      public BulkDeleteDocumentsMetadata.Builder setNamespaceIds(int index, String value)
       Which namespace IDs are being deleted.
      repeated string namespace_ids = 7;
      Parameters:
      index - The index to set the value at.
      value - The namespaceIds to set.
      Returns:
      This builder for chaining.

    • addNamespaceIds

      public BulkDeleteDocumentsMetadata.Builder addNamespaceIds(String value)
       Which namespace IDs are being deleted.
      repeated string namespace_ids = 7;
      Parameters:
      value - The namespaceIds to add.
      Returns:
      This builder for chaining.

    • addAllNamespaceIds

      public BulkDeleteDocumentsMetadata.Builder addAllNamespaceIds(Iterable<String> values)
       Which namespace IDs are being deleted.
      repeated string namespace_ids = 7;
      Parameters:
      values - The namespaceIds to add.
      Returns:
      This builder for chaining.

    • clearNamespaceIds

      public BulkDeleteDocumentsMetadata.Builder clearNamespaceIds()
       Which namespace IDs are being deleted.
      repeated string namespace_ids = 7;
      Returns:
      This builder for chaining.

    • addNamespaceIdsBytes

      public BulkDeleteDocumentsMetadata.Builder addNamespaceIdsBytes(com.google.protobuf.ByteString value)
       Which namespace IDs are being deleted.
      repeated string namespace_ids = 7;
      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 that is being
 read to get the list of documents to delete. This time can also be used as
 the timestamp of PITR in case of disaster recovery (subject to PITR window
 limit).
      .google.protobuf.Timestamp snapshot_time = 8;
      Specified by:
      hasSnapshotTime in interface BulkDeleteDocumentsMetadataOrBuilder
      Returns:
      Whether the snapshotTime field is set.

    • getSnapshotTime

      public com.google.protobuf.Timestamp getSnapshotTime()
       The timestamp that corresponds to the version of the database that is being
 read to get the list of documents to delete. This time can also be used as
 the timestamp of PITR in case of disaster recovery (subject to PITR window
 limit).
      .google.protobuf.Timestamp snapshot_time = 8;
      Specified by:
      getSnapshotTime in interface BulkDeleteDocumentsMetadataOrBuilder
      Returns:
      The snapshotTime.

    • setSnapshotTime

      public BulkDeleteDocumentsMetadata.Builder setSnapshotTime(com.google.protobuf.Timestamp value)
       The timestamp that corresponds to the version of the database that is being
 read to get the list of documents to delete. This time can also be used as
 the timestamp of PITR in case of disaster recovery (subject to PITR window
 limit).
      .google.protobuf.Timestamp snapshot_time = 8;

    • setSnapshotTime

      public BulkDeleteDocumentsMetadata.Builder setSnapshotTime(com.google.protobuf.Timestamp.Builder builderForValue)
       The timestamp that corresponds to the version of the database that is being
 read to get the list of documents to delete. This time can also be used as
 the timestamp of PITR in case of disaster recovery (subject to PITR window
 limit).
      .google.protobuf.Timestamp snapshot_time = 8;

    • mergeSnapshotTime

      public BulkDeleteDocumentsMetadata.Builder mergeSnapshotTime(com.google.protobuf.Timestamp value)
       The timestamp that corresponds to the version of the database that is being
 read to get the list of documents to delete. This time can also be used as
 the timestamp of PITR in case of disaster recovery (subject to PITR window
 limit).
      .google.protobuf.Timestamp snapshot_time = 8;

    • clearSnapshotTime

      public BulkDeleteDocumentsMetadata.Builder clearSnapshotTime()
       The timestamp that corresponds to the version of the database that is being
 read to get the list of documents to delete. This time can also be used as
 the timestamp of PITR in case of disaster recovery (subject to PITR window
 limit).
      .google.protobuf.Timestamp snapshot_time = 8;

    • getSnapshotTimeBuilder

      public com.google.protobuf.Timestamp.Builder getSnapshotTimeBuilder()
       The timestamp that corresponds to the version of the database that is being
 read to get the list of documents to delete. This time can also be used as
 the timestamp of PITR in case of disaster recovery (subject to PITR window
 limit).
      .google.protobuf.Timestamp snapshot_time = 8;

    • getSnapshotTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getSnapshotTimeOrBuilder()
       The timestamp that corresponds to the version of the database that is being
 read to get the list of documents to delete. This time can also be used as
 the timestamp of PITR in case of disaster recovery (subject to PITR window
 limit).
      .google.protobuf.Timestamp snapshot_time = 8;
      Specified by:
      getSnapshotTimeOrBuilder in interface BulkDeleteDocumentsMetadataOrBuilder