Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::ExportDocumentsMetadata.
Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#collection_ids
def collection_ids() -> ::Array<::String>
Returns
- (::Array<::String>) — Which collection ids are being exported.
#collection_ids=
def collection_ids=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Which collection ids are being exported.
Returns
- (::Array<::String>) — Which collection ids are being exported.
#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 exported.
#namespace_ids=
def namespace_ids=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Which namespace ids are being exported.
Returns
- (::Array<::String>) — Which namespace ids are being exported.
#operation_state
def operation_state() -> ::Google::Cloud::Firestore::Admin::V1::OperationState
Returns
- (::Google::Cloud::Firestore::Admin::V1::OperationState) — The state of the export 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 export operation.
Returns
- (::Google::Cloud::Firestore::Admin::V1::OperationState) — The state of the export operation.
#output_uri_prefix
def output_uri_prefix() -> ::String
Returns
- (::String) — Where the documents are being exported to.
#output_uri_prefix=
def output_uri_prefix=(value) -> ::String
Parameter
- value (::String) — Where the documents are being exported to.
Returns
- (::String) — Where the documents are being exported to.
#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 exported. If unspecified, there are no guarantees about the consistency of the documents being exported.
#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 exported. If unspecified, there are no guarantees about the consistency of the documents being exported.
Returns
- (::Google::Protobuf::Timestamp) — The timestamp that corresponds to the version of the database that is being exported. If unspecified, there are no guarantees about the consistency of the documents being exported.
#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.