Class: Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsMetadata

Inherits:

Object

• Object
• Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsMetadata

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/firestore/admin/v1/operation.rb

Overview

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

Instance Attribute Summary

• #collection_ids ⇒ ::Array<::String>

  The IDs of the collection groups that are being deleted.

• #end_time ⇒ ::Google::Protobuf::Timestamp

  The time this operation completed.

• #namespace_ids ⇒ ::Array<::String>

  Which namespace IDs are being deleted.

• #operation_state ⇒ ::Google::Cloud::Firestore::Admin::V1::OperationState

  The state of the operation.

• #progress_bytes ⇒ ::Google::Cloud::Firestore::Admin::V1::Progress

  The progress, in bytes, of this operation.

• #progress_documents ⇒ ::Google::Cloud::Firestore::Admin::V1::Progress

  The progress, in documents, of this operation.

• #snapshot_time ⇒ ::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.

• #start_time ⇒ ::Google::Protobuf::Timestamp

  The time this operation started.

Instance Attribute Details

#collection_ids ⇒ ::Array<::String>

Returns The IDs of the collection groups that are being deleted.

Returns:

• (::Array<::String>) —

  The IDs of the collection groups that are being deleted.

# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 236

class BulkDeleteDocumentsMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns 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.

# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 236

class BulkDeleteDocumentsMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#namespace_ids ⇒ ::Array<::String>

Returns Which namespace IDs are being deleted.

Returns:

• (::Array<::String>) —

  Which namespace IDs are being deleted.

# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 236

class BulkDeleteDocumentsMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#operation_state ⇒ ::Google::Cloud::Firestore::Admin::V1::OperationState

Returns The state of the operation.

Returns:

• (::Google::Cloud::Firestore::Admin::V1::OperationState) —

  The state of the operation.

# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 236

class BulkDeleteDocumentsMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#progress_bytes ⇒ ::Google::Cloud::Firestore::Admin::V1::Progress

Returns The progress, in bytes, of this operation.

Returns:

• (::Google::Cloud::Firestore::Admin::V1::Progress) —

  The progress, in bytes, of this operation.

# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 236

class BulkDeleteDocumentsMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#progress_documents ⇒ ::Google::Cloud::Firestore::Admin::V1::Progress

Returns The progress, in documents, of this operation.

Returns:

• (::Google::Cloud::Firestore::Admin::V1::Progress) —

  The progress, in documents, of this operation.

# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 236

class BulkDeleteDocumentsMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#snapshot_time ⇒ ::Google::Protobuf::Timestamp

Returns 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).

# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 236

class BulkDeleteDocumentsMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns The time this operation started.

Returns:

• (::Google::Protobuf::Timestamp) —

  The time this operation started.

# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 236

class BulkDeleteDocumentsMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end