Interface BulkDeleteDocumentsRequestOrBuilder (3.26.5)

Version 3.26.5

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public interface BulkDeleteDocumentsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCollectionIds(int index)

public abstract 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];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The collectionIds at the given index.

getCollectionIdsBytes(int index)

public abstract 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];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the collectionIds at the given index.

getCollectionIdsCount()

public abstract 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
Type	Description
int	The count of collectionIds.

getCollectionIdsList()

public abstract 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
Type	Description
List<String>	A list containing the collectionIds.

getName()

public abstract 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
Type	Description
String	The name.

getNameBytes()

public abstract 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
Type	Description
ByteString	The bytes for name.

getNamespaceIds(int index)

public abstract 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];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The namespaceIds at the given index.

getNamespaceIdsBytes(int index)

public abstract 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];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the namespaceIds at the given index.

getNamespaceIdsCount()

public abstract 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
Type	Description
int	The count of namespaceIds.

getNamespaceIdsList()

public abstract 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
Type	Description
List<String>	A list containing the namespaceIds.