Package com.google.firestore.admin.v1

Interface BulkDeleteDocumentsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BulkDeleteDocumentsRequest, BulkDeleteDocumentsRequest.Builder
@Generated public interface BulkDeleteDocumentsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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) = { ... }
      Returns:
      The name.

    • getNameBytes

      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) = { ... }
      Returns:
      The bytes for name.

    • getCollectionIdsList

      List<String> 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];
      Returns:
      A list containing the collectionIds.

    • getCollectionIdsCount

      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];
      Returns:
      The count of collectionIds.

    • getCollectionIds

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The collectionIds at the given index.

    • getCollectionIdsBytes

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the collectionIds at the given index.

    • getNamespaceIdsList

      List<String> 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];
      Returns:
      A list containing the namespaceIds.

    • getNamespaceIdsCount

      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];
      Returns:
      The count of namespaceIds.

    • getNamespaceIds

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The namespaceIds at the given index.

    • getNamespaceIdsBytes

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the namespaceIds at the given index.