Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsMetadata.
Metadata for google.longrunning.Operation results from FirestoreAdmin.BulkDeleteDocuments.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#collection_ids
def collection_ids() -> ::Array<::String>
Returns
- (::Array<::String>) — The ids of the collection groups that are being deleted.
#collection_ids=
def collection_ids=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — The ids of the collection groups that are being deleted.
Returns
- (::Array<::String>) — The ids of the collection groups that are being deleted.
#end_time
def end_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — The time this operation completed. Will be unset if operation still in progress.
#end_time=
def end_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — The time this operation completed. Will be unset if operation still in progress.
Returns
- (::Google::Protobuf::Timestamp) — The time this operation completed. Will be unset if operation still in progress.
#namespace_ids
def namespace_ids() -> ::Array<::String>
Returns
- (::Array<::String>) — Which namespace ids are being deleted.
#namespace_ids=
def namespace_ids=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Which namespace ids are being deleted.
Returns
- (::Array<::String>) — Which namespace ids are being deleted.
#operation_state
def operation_state() -> ::Google::Cloud::Firestore::Admin::V1::OperationState
Returns
- (::Google::Cloud::Firestore::Admin::V1::OperationState) — The state of the operation.
#operation_state=
def operation_state=(value) -> ::Google::Cloud::Firestore::Admin::V1::OperationState
Parameter
- value (::Google::Cloud::Firestore::Admin::V1::OperationState) — The state of the operation.
Returns
- (::Google::Cloud::Firestore::Admin::V1::OperationState) — The state of the operation.
#progress_bytes
def progress_bytes() -> ::Google::Cloud::Firestore::Admin::V1::Progress
Returns
- (::Google::Cloud::Firestore::Admin::V1::Progress) — The progress, in bytes, of this operation.
#progress_bytes=
def progress_bytes=(value) -> ::Google::Cloud::Firestore::Admin::V1::Progress
Parameter
- value (::Google::Cloud::Firestore::Admin::V1::Progress) — The progress, in bytes, of this operation.
Returns
- (::Google::Cloud::Firestore::Admin::V1::Progress) — The progress, in bytes, of this operation.
#progress_documents
def progress_documents() -> ::Google::Cloud::Firestore::Admin::V1::Progress
Returns
- (::Google::Cloud::Firestore::Admin::V1::Progress) — The progress, in documents, of this operation.
#progress_documents=
def progress_documents=(value) -> ::Google::Cloud::Firestore::Admin::V1::Progress
Parameter
- value (::Google::Cloud::Firestore::Admin::V1::Progress) — The progress, in documents, of this operation.
Returns
- (::Google::Cloud::Firestore::Admin::V1::Progress) — The progress, in documents, of this operation.
#snapshot_time
def snapshot_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — 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).
#snapshot_time=
def snapshot_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — 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).
Returns
- (::Google::Protobuf::Timestamp) — 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).
#start_time
def start_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — The time this operation started.
#start_time=
def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — The time this operation started.
Returns
- (::Google::Protobuf::Timestamp) — The time this operation started.