Class BulkDeleteDocumentsRequest (3.26.5)

public final class BulkDeleteDocumentsRequest extends GeneratedMessageV3 implements BulkDeleteDocumentsRequestOrBuilder

The request for 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 instead.

Protobuf type google.firestore.admin.v1.BulkDeleteDocumentsRequest

Static Fields

COLLECTION_IDS_FIELD_NUMBER

public static final int COLLECTION_IDS_FIELD_NUMBER
Field Value
Type Description
int

NAMESPACE_IDS_FIELD_NUMBER

public static final int NAMESPACE_IDS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BulkDeleteDocumentsRequest getDefaultInstance()
Returns
Type Description
BulkDeleteDocumentsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BulkDeleteDocumentsRequest.Builder newBuilder()
Returns
Type Description
BulkDeleteDocumentsRequest.Builder

newBuilder(BulkDeleteDocumentsRequest prototype)

public static BulkDeleteDocumentsRequest.Builder newBuilder(BulkDeleteDocumentsRequest prototype)
Parameter
Name Description
prototype BulkDeleteDocumentsRequest
Returns
Type Description
BulkDeleteDocumentsRequest.Builder

parseDelimitedFrom(InputStream input)

public static BulkDeleteDocumentsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BulkDeleteDocumentsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BulkDeleteDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BulkDeleteDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BulkDeleteDocumentsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BulkDeleteDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BulkDeleteDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BulkDeleteDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BulkDeleteDocumentsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BulkDeleteDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BulkDeleteDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BulkDeleteDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BulkDeleteDocumentsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BulkDeleteDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BulkDeleteDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BulkDeleteDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BulkDeleteDocumentsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BulkDeleteDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BulkDeleteDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BulkDeleteDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BulkDeleteDocumentsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BulkDeleteDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BulkDeleteDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BulkDeleteDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BulkDeleteDocumentsRequest> parser()
Returns
Type Description
Parser<BulkDeleteDocumentsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCollectionIds(int index)

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

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

Returns
Type Description
ProtocolStringList

A list containing the collectionIds.

getDefaultInstanceForType()

public BulkDeleteDocumentsRequest getDefaultInstanceForType()
Returns
Type Description
BulkDeleteDocumentsRequest

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) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

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

Returns
Type Description
ProtocolStringList

A list containing the namespaceIds.

getParserForType()

public Parser<BulkDeleteDocumentsRequest> getParserForType()
Returns
Type Description
Parser<BulkDeleteDocumentsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BulkDeleteDocumentsRequest.Builder newBuilderForType()
Returns
Type Description
BulkDeleteDocumentsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BulkDeleteDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BulkDeleteDocumentsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BulkDeleteDocumentsRequest.Builder toBuilder()
Returns
Type Description
BulkDeleteDocumentsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException