Class BulkDeleteDocumentsMetadata.Builder (3.28.0)

public static final class BulkDeleteDocumentsMetadata.Builder extends GeneratedMessageV3.Builder<BulkDeleteDocumentsMetadata.Builder> implements BulkDeleteDocumentsMetadataOrBuilder

Metadata for google.longrunning.Operation results from FirestoreAdmin.BulkDeleteDocuments.

Protobuf type google.firestore.admin.v1.BulkDeleteDocumentsMetadata

Static Methods

getDescriptor()

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

Methods

addAllCollectionIds(Iterable<String> values)

public BulkDeleteDocumentsMetadata.Builder addAllCollectionIds(Iterable<String> values)

The IDs of the collection groups that are being deleted.

repeated string collection_ids = 6;

Parameter
Name Description
values Iterable<String>

The collectionIds to add.

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

This builder for chaining.

addAllNamespaceIds(Iterable<String> values)

public BulkDeleteDocumentsMetadata.Builder addAllNamespaceIds(Iterable<String> values)

Which namespace IDs are being deleted.

repeated string namespace_ids = 7;

Parameter
Name Description
values Iterable<String>

The namespaceIds to add.

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

This builder for chaining.

addCollectionIds(String value)

public BulkDeleteDocumentsMetadata.Builder addCollectionIds(String value)

The IDs of the collection groups that are being deleted.

repeated string collection_ids = 6;

Parameter
Name Description
value String

The collectionIds to add.

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

This builder for chaining.

addCollectionIdsBytes(ByteString value)

public BulkDeleteDocumentsMetadata.Builder addCollectionIdsBytes(ByteString value)

The IDs of the collection groups that are being deleted.

repeated string collection_ids = 6;

Parameter
Name Description
value ByteString

The bytes of the collectionIds to add.

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

This builder for chaining.

addNamespaceIds(String value)

public BulkDeleteDocumentsMetadata.Builder addNamespaceIds(String value)

Which namespace IDs are being deleted.

repeated string namespace_ids = 7;

Parameter
Name Description
value String

The namespaceIds to add.

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

This builder for chaining.

addNamespaceIdsBytes(ByteString value)

public BulkDeleteDocumentsMetadata.Builder addNamespaceIdsBytes(ByteString value)

Which namespace IDs are being deleted.

repeated string namespace_ids = 7;

Parameter
Name Description
value ByteString

The bytes of the namespaceIds to add.

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BulkDeleteDocumentsMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder
Overrides

build()

public BulkDeleteDocumentsMetadata build()
Returns
Type Description
BulkDeleteDocumentsMetadata

buildPartial()

public BulkDeleteDocumentsMetadata buildPartial()
Returns
Type Description
BulkDeleteDocumentsMetadata

clear()

public BulkDeleteDocumentsMetadata.Builder clear()
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder
Overrides

clearCollectionIds()

public BulkDeleteDocumentsMetadata.Builder clearCollectionIds()

The IDs of the collection groups that are being deleted.

repeated string collection_ids = 6;

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

This builder for chaining.

clearEndTime()

public BulkDeleteDocumentsMetadata.Builder clearEndTime()

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

public BulkDeleteDocumentsMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder
Overrides

clearNamespaceIds()

public BulkDeleteDocumentsMetadata.Builder clearNamespaceIds()

Which namespace IDs are being deleted.

repeated string namespace_ids = 7;

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BulkDeleteDocumentsMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder
Overrides

clearOperationState()

public BulkDeleteDocumentsMetadata.Builder clearOperationState()

The state of the operation.

.google.firestore.admin.v1.OperationState operation_state = 3;

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

This builder for chaining.

clearProgressBytes()

public BulkDeleteDocumentsMetadata.Builder clearProgressBytes()

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 5;

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

clearProgressDocuments()

public BulkDeleteDocumentsMetadata.Builder clearProgressDocuments()

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 4;

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

clearSnapshotTime()

public BulkDeleteDocumentsMetadata.Builder clearSnapshotTime()

The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit).

.google.protobuf.Timestamp snapshot_time = 8;

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

clearStartTime()

public BulkDeleteDocumentsMetadata.Builder clearStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

clone()

public BulkDeleteDocumentsMetadata.Builder clone()
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder
Overrides

getCollectionIds(int index)

public String getCollectionIds(int index)

The IDs of the collection groups that are being deleted.

repeated string collection_ids = 6;

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)

The IDs of the collection groups that are being deleted.

repeated string collection_ids = 6;

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()

The IDs of the collection groups that are being deleted.

repeated string collection_ids = 6;

Returns
Type Description
int

The count of collectionIds.

getCollectionIdsList()

public ProtocolStringList getCollectionIdsList()

The IDs of the collection groups that are being deleted.

repeated string collection_ids = 6;

Returns
Type Description
ProtocolStringList

A list containing the collectionIds.

getDefaultInstanceForType()

public BulkDeleteDocumentsMetadata getDefaultInstanceForType()
Returns
Type Description
BulkDeleteDocumentsMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEndTime()

public Timestamp getEndTime()

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
TimestampOrBuilder

getNamespaceIds(int index)

public String getNamespaceIds(int index)

Which namespace IDs are being deleted.

repeated string namespace_ids = 7;

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)

Which namespace IDs are being deleted.

repeated string namespace_ids = 7;

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()

Which namespace IDs are being deleted.

repeated string namespace_ids = 7;

Returns
Type Description
int

The count of namespaceIds.

getNamespaceIdsList()

public ProtocolStringList getNamespaceIdsList()

Which namespace IDs are being deleted.

repeated string namespace_ids = 7;

Returns
Type Description
ProtocolStringList

A list containing the namespaceIds.

getOperationState()

public OperationState getOperationState()

The state of the operation.

.google.firestore.admin.v1.OperationState operation_state = 3;

Returns
Type Description
OperationState

The operationState.

getOperationStateValue()

public int getOperationStateValue()

The state of the operation.

.google.firestore.admin.v1.OperationState operation_state = 3;

Returns
Type Description
int

The enum numeric value on the wire for operationState.

getProgressBytes()

public Progress getProgressBytes()

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 5;

Returns
Type Description
Progress

The progressBytes.

getProgressBytesBuilder()

public Progress.Builder getProgressBytesBuilder()

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 5;

Returns
Type Description
Progress.Builder

getProgressBytesOrBuilder()

public ProgressOrBuilder getProgressBytesOrBuilder()

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 5;

Returns
Type Description
ProgressOrBuilder

getProgressDocuments()

public Progress getProgressDocuments()

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 4;

Returns
Type Description
Progress

The progressDocuments.

getProgressDocumentsBuilder()

public Progress.Builder getProgressDocumentsBuilder()

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 4;

Returns
Type Description
Progress.Builder

getProgressDocumentsOrBuilder()

public ProgressOrBuilder getProgressDocumentsOrBuilder()

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 4;

Returns
Type Description
ProgressOrBuilder

getSnapshotTime()

public Timestamp getSnapshotTime()

The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit).

.google.protobuf.Timestamp snapshot_time = 8;

Returns
Type Description
Timestamp

The snapshotTime.

getSnapshotTimeBuilder()

public Timestamp.Builder getSnapshotTimeBuilder()

The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit).

.google.protobuf.Timestamp snapshot_time = 8;

Returns
Type Description
Builder

getSnapshotTimeOrBuilder()

public TimestampOrBuilder getSnapshotTimeOrBuilder()

The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit).

.google.protobuf.Timestamp snapshot_time = 8;

Returns
Type Description
TimestampOrBuilder

getStartTime()

public Timestamp getStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
TimestampOrBuilder

hasEndTime()

public boolean hasEndTime()

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
boolean

Whether the endTime field is set.

hasProgressBytes()

public boolean hasProgressBytes()

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 5;

Returns
Type Description
boolean

Whether the progressBytes field is set.

hasProgressDocuments()

public boolean hasProgressDocuments()

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 4;

Returns
Type Description
boolean

Whether the progressDocuments field is set.

hasSnapshotTime()

public boolean hasSnapshotTime()

The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit).

.google.protobuf.Timestamp snapshot_time = 8;

Returns
Type Description
boolean

Whether the snapshotTime field is set.

hasStartTime()

public boolean hasStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
boolean

Whether the startTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndTime(Timestamp value)

public BulkDeleteDocumentsMetadata.Builder mergeEndTime(Timestamp value)

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

mergeFrom(BulkDeleteDocumentsMetadata other)

public BulkDeleteDocumentsMetadata.Builder mergeFrom(BulkDeleteDocumentsMetadata other)
Parameter
Name Description
other BulkDeleteDocumentsMetadata
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BulkDeleteDocumentsMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BulkDeleteDocumentsMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder
Overrides

mergeProgressBytes(Progress value)

public BulkDeleteDocumentsMetadata.Builder mergeProgressBytes(Progress value)

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 5;

Parameter
Name Description
value Progress
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

mergeProgressDocuments(Progress value)

public BulkDeleteDocumentsMetadata.Builder mergeProgressDocuments(Progress value)

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 4;

Parameter
Name Description
value Progress
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

mergeSnapshotTime(Timestamp value)

public BulkDeleteDocumentsMetadata.Builder mergeSnapshotTime(Timestamp value)

The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit).

.google.protobuf.Timestamp snapshot_time = 8;

Parameter
Name Description
value Timestamp
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

mergeStartTime(Timestamp value)

public BulkDeleteDocumentsMetadata.Builder mergeStartTime(Timestamp value)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BulkDeleteDocumentsMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder
Overrides

setCollectionIds(int index, String value)

public BulkDeleteDocumentsMetadata.Builder setCollectionIds(int index, String value)

The IDs of the collection groups that are being deleted.

repeated string collection_ids = 6;

Parameters
Name Description
index int

The index to set the value at.

value String

The collectionIds to set.

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

This builder for chaining.

setEndTime(Timestamp value)

public BulkDeleteDocumentsMetadata.Builder setEndTime(Timestamp value)

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

setEndTime(Timestamp.Builder builderForValue)

public BulkDeleteDocumentsMetadata.Builder setEndTime(Timestamp.Builder builderForValue)

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BulkDeleteDocumentsMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder
Overrides

setNamespaceIds(int index, String value)

public BulkDeleteDocumentsMetadata.Builder setNamespaceIds(int index, String value)

Which namespace IDs are being deleted.

repeated string namespace_ids = 7;

Parameters
Name Description
index int

The index to set the value at.

value String

The namespaceIds to set.

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

This builder for chaining.

setOperationState(OperationState value)

public BulkDeleteDocumentsMetadata.Builder setOperationState(OperationState value)

The state of the operation.

.google.firestore.admin.v1.OperationState operation_state = 3;

Parameter
Name Description
value OperationState

The operationState to set.

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

This builder for chaining.

setOperationStateValue(int value)

public BulkDeleteDocumentsMetadata.Builder setOperationStateValue(int value)

The state of the operation.

.google.firestore.admin.v1.OperationState operation_state = 3;

Parameter
Name Description
value int

The enum numeric value on the wire for operationState to set.

Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

This builder for chaining.

setProgressBytes(Progress value)

public BulkDeleteDocumentsMetadata.Builder setProgressBytes(Progress value)

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 5;

Parameter
Name Description
value Progress
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

setProgressBytes(Progress.Builder builderForValue)

public BulkDeleteDocumentsMetadata.Builder setProgressBytes(Progress.Builder builderForValue)

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 5;

Parameter
Name Description
builderForValue Progress.Builder
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

setProgressDocuments(Progress value)

public BulkDeleteDocumentsMetadata.Builder setProgressDocuments(Progress value)

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 4;

Parameter
Name Description
value Progress
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

setProgressDocuments(Progress.Builder builderForValue)

public BulkDeleteDocumentsMetadata.Builder setProgressDocuments(Progress.Builder builderForValue)

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 4;

Parameter
Name Description
builderForValue Progress.Builder
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BulkDeleteDocumentsMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder
Overrides

setSnapshotTime(Timestamp value)

public BulkDeleteDocumentsMetadata.Builder setSnapshotTime(Timestamp value)

The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit).

.google.protobuf.Timestamp snapshot_time = 8;

Parameter
Name Description
value Timestamp
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

setSnapshotTime(Timestamp.Builder builderForValue)

public BulkDeleteDocumentsMetadata.Builder setSnapshotTime(Timestamp.Builder builderForValue)

The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit).

.google.protobuf.Timestamp snapshot_time = 8;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

setStartTime(Timestamp value)

public BulkDeleteDocumentsMetadata.Builder setStartTime(Timestamp value)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

setStartTime(Timestamp.Builder builderForValue)

public BulkDeleteDocumentsMetadata.Builder setStartTime(Timestamp.Builder builderForValue)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final BulkDeleteDocumentsMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BulkDeleteDocumentsMetadata.Builder
Overrides