Cloud Firestore V1 Client - Class ExportDocumentsMetadata (1.53.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class ExportDocumentsMetadata.

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

Generated from protobuf message google.firestore.admin.v1.ExportDocumentsMetadata

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ start_time
Google\Protobuf\Timestamp

The time this operation started.

↳ end_time
Google\Protobuf\Timestamp

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

↳ operation_state
int

The state of the export operation.

↳ progress_documents
Progress

The progress, in documents, of this operation.

↳ progress_bytes
Progress

The progress, in bytes, of this operation.

↳ collection_ids
array

Which collection IDs are being exported.

↳ output_uri_prefix
string

Where the documents are being exported to.

↳ namespace_ids
array

Which namespace IDs are being exported.

↳ snapshot_time
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.

The time this operation started.

Returns
Type
Description

The time this operation started.

Parameter
Name
Description
Returns
Type
Description
$this

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

Returns
Type
Description

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

Parameter
Name
Description
Returns
Type
Description
$this

The state of the export operation.

Returns
Type
Description
int

The state of the export operation.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

The progress, in documents, of this operation.

Returns
Type
Description
Progress |null

The progress, in documents, of this operation.

Parameter
Name
Description
var
Returns
Type
Description
$this

The progress, in bytes, of this operation.

Returns
Type
Description
Progress |null

The progress, in bytes, of this operation.

Parameter
Name
Description
var
Returns
Type
Description
$this

Which collection IDs are being exported.

Returns
Type
Description

Which collection IDs are being exported.

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

Where the documents are being exported to.

Returns
Type
Description
string

Where the documents are being exported to.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

Which namespace IDs are being exported.

Returns
Type
Description

Which namespace IDs are being exported.

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

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
Type
Description

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.

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: