Class: Google::Cloud::Firestore::Admin::V1::ExportDocumentsMetadata

Inherits:
Object
  • Object
show all
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.ExportDocuments.

Instance Attribute Summary collapse

Instance Attribute Details

#collection_ids ⇒ ::Array<::String>

Returns Which collection IDs are being exported.

Returns:

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

    Which collection IDs are being exported.



167
168
169
170
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 167

class ExportDocumentsMetadata
  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:



167
168
169
170
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 167

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

#namespace_ids ⇒ ::Array<::String>

Returns Which namespace IDs are being exported.

Returns:

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

    Which namespace IDs are being exported.



167
168
169
170
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 167

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

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

Returns The state of the export operation.

Returns:



167
168
169
170
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 167

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

#output_uri_prefix ⇒ ::String

Returns Where the documents are being exported to.

Returns:

  • (::String) —

    Where the documents are being exported to.



167
168
169
170
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 167

class ExportDocumentsMetadata
  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:



167
168
169
170
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 167

class ExportDocumentsMetadata
  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:



167
168
169
170
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 167

class ExportDocumentsMetadata
  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 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.



167
168
169
170
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 167

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

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

Returns The time this operation started.

Returns:



167
168
169
170
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 167

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