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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BulkDeleteDocumentsRequest.Builder newBuilder()
newBuilder(BulkDeleteDocumentsRequest prototype)
public static BulkDeleteDocumentsRequest.Builder newBuilder(BulkDeleteDocumentsRequest prototype)
public static BulkDeleteDocumentsRequest parseDelimitedFrom(InputStream input)
public static BulkDeleteDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BulkDeleteDocumentsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BulkDeleteDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BulkDeleteDocumentsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BulkDeleteDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BulkDeleteDocumentsRequest parseFrom(CodedInputStream input)
public static BulkDeleteDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BulkDeleteDocumentsRequest parseFrom(InputStream input)
public static BulkDeleteDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BulkDeleteDocumentsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BulkDeleteDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BulkDeleteDocumentsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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];
getDefaultInstanceForType()
public BulkDeleteDocumentsRequest getDefaultInstanceForType()
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];
getParserForType()
public Parser<BulkDeleteDocumentsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BulkDeleteDocumentsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BulkDeleteDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public BulkDeleteDocumentsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
