Package com.google.firestore.admin.v1

Class BulkDeleteDocumentsRequest.Builder

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

 When both collection_ids and namespace_ids are set, only documents satisfying
 both conditions will be deleted.

 Requests with namespace_ids and collection_ids both empty will be rejected.
 Please use
 [FirestoreAdmin.DeleteDatabase][google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase]
 instead.
Protobuf type google.firestore.admin.v1.BulkDeleteDocumentsRequest

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public BulkDeleteDocumentsRequest.Builder mergeFrom(BulkDeleteDocumentsRequest other)

    • isInitialized

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

    • mergeFrom

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

    • getName

      public String getName()
       Required. Database to operate. 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 BulkDeleteDocumentsRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. Database to operate. 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 BulkDeleteDocumentsRequestOrBuilder
      Returns:
      The bytes for name.

    • setName

      public BulkDeleteDocumentsRequest.Builder setName(String value)
       Required. Database to operate. 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 BulkDeleteDocumentsRequest.Builder clearName()
       Required. Database to operate. 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 BulkDeleteDocumentsRequest.Builder setNameBytes(com.google.protobuf.ByteString value)
       Required. Database to operate. 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()
       Optional. IDs of the collection groups to delete. Unspecified means all
 collection groups.

 Each collection group in this list must be unique.
      repeated string collection_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCollectionIdsList in interface BulkDeleteDocumentsRequestOrBuilder
      Returns:
      A list containing the collectionIds.

    • getCollectionIdsCount

      public int getCollectionIdsCount()
       Optional. IDs of the collection groups to delete. Unspecified means all
 collection groups.

 Each collection group in this list must be unique.
      repeated string collection_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCollectionIdsCount in interface BulkDeleteDocumentsRequestOrBuilder
      Returns:
      The count of collectionIds.

    • getCollectionIds

      public String getCollectionIds(int index)
       Optional. IDs of the collection groups to delete. Unspecified means all
 collection groups.

 Each collection group in this list must be unique.
      repeated string collection_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCollectionIds in interface BulkDeleteDocumentsRequestOrBuilder
      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)
       Optional. IDs of the collection groups to delete. Unspecified means all
 collection groups.

 Each collection group in this list must be unique.
      repeated string collection_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCollectionIdsBytes in interface BulkDeleteDocumentsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the collectionIds at the given index.

    • setCollectionIds

      public BulkDeleteDocumentsRequest.Builder setCollectionIds(int index, String value)
       Optional. IDs of the collection groups to delete. Unspecified means all
 collection groups.

 Each collection group in this list must be unique.
      repeated string collection_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index to set the value at.
      value - The collectionIds to set.
      Returns:
      This builder for chaining.

    • addCollectionIds

      public BulkDeleteDocumentsRequest.Builder addCollectionIds(String value)
       Optional. IDs of the collection groups to delete. Unspecified means all
 collection groups.

 Each collection group in this list must be unique.
      repeated string collection_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The collectionIds to add.
      Returns:
      This builder for chaining.

    • addAllCollectionIds

      public BulkDeleteDocumentsRequest.Builder addAllCollectionIds(Iterable<String> values)
       Optional. IDs of the collection groups to delete. Unspecified means all
 collection groups.

 Each collection group in this list must be unique.
      repeated string collection_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      values - The collectionIds to add.
      Returns:
      This builder for chaining.

    • clearCollectionIds

      public BulkDeleteDocumentsRequest.Builder clearCollectionIds()
       Optional. IDs of the collection groups to delete. Unspecified means all
 collection groups.

 Each collection group in this list must be unique.
      repeated string collection_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • addCollectionIdsBytes

      public BulkDeleteDocumentsRequest.Builder addCollectionIdsBytes(com.google.protobuf.ByteString value)
       Optional. IDs of the collection groups to delete. Unspecified means all
 collection groups.

 Each collection group in this list must be unique.
      repeated string collection_ids = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes of the collectionIds to add.
      Returns:
      This builder for chaining.

    • getNamespaceIdsList

      public com.google.protobuf.ProtocolStringList getNamespaceIdsList()
       Optional. Namespaces to delete.

 An empty list means all namespaces. This is the recommended
 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 delete from them.

 Each namespace in this list must be unique.
      repeated string namespace_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getNamespaceIdsList in interface BulkDeleteDocumentsRequestOrBuilder
      Returns:
      A list containing the namespaceIds.

    • getNamespaceIdsCount

      public int getNamespaceIdsCount()
       Optional. Namespaces to delete.

 An empty list means all namespaces. This is the recommended
 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 delete from them.

 Each namespace in this list must be unique.
      repeated string namespace_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getNamespaceIdsCount in interface BulkDeleteDocumentsRequestOrBuilder
      Returns:
      The count of namespaceIds.

    • getNamespaceIds

      public String getNamespaceIds(int index)
       Optional. Namespaces to delete.

 An empty list means all namespaces. This is the recommended
 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 delete from them.

 Each namespace in this list must be unique.
      repeated string namespace_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getNamespaceIds in interface BulkDeleteDocumentsRequestOrBuilder
      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)
       Optional. Namespaces to delete.

 An empty list means all namespaces. This is the recommended
 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 delete from them.

 Each namespace in this list must be unique.
      repeated string namespace_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getNamespaceIdsBytes in interface BulkDeleteDocumentsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the namespaceIds at the given index.

    • setNamespaceIds

      public BulkDeleteDocumentsRequest.Builder setNamespaceIds(int index, String value)
       Optional. Namespaces to delete.

 An empty list means all namespaces. This is the recommended
 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 delete from them.

 Each namespace in this list must be unique.
      repeated string namespace_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index to set the value at.
      value - The namespaceIds to set.
      Returns:
      This builder for chaining.

    • addNamespaceIds

      public BulkDeleteDocumentsRequest.Builder addNamespaceIds(String value)
       Optional. Namespaces to delete.

 An empty list means all namespaces. This is the recommended
 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 delete from them.

 Each namespace in this list must be unique.
      repeated string namespace_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The namespaceIds to add.
      Returns:
      This builder for chaining.

    • addAllNamespaceIds

      public BulkDeleteDocumentsRequest.Builder addAllNamespaceIds(Iterable<String> values)
       Optional. Namespaces to delete.

 An empty list means all namespaces. This is the recommended
 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 delete from them.

 Each namespace in this list must be unique.
      repeated string namespace_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      values - The namespaceIds to add.
      Returns:
      This builder for chaining.

    • clearNamespaceIds

      public BulkDeleteDocumentsRequest.Builder clearNamespaceIds()
       Optional. Namespaces to delete.

 An empty list means all namespaces. This is the recommended
 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 delete from them.

 Each namespace in this list must be unique.
      repeated string namespace_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • addNamespaceIdsBytes

      public BulkDeleteDocumentsRequest.Builder addNamespaceIdsBytes(com.google.protobuf.ByteString value)
       Optional. Namespaces to delete.

 An empty list means all namespaces. This is the recommended
 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 delete from them.

 Each namespace in this list must be unique.
      repeated string namespace_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes of the namespaceIds to add.
      Returns:
      This builder for chaining.