Cloud Firestore V1 Client - Class ExportDocumentsMetadata (1.39.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

__construct

Constructor.

Parameters
NameDescription
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 Google\Cloud\Firestore\Admin\V1\Progress

The progress, in documents, of this operation.

↳ progress_bytes Google\Cloud\Firestore\Admin\V1\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.

getStartTime

The time this operation started.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

The time this operation started.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getOperationState

The state of the export operation.

Returns
TypeDescription
int

setOperationState

The state of the export operation.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getProgressDocuments

The progress, in documents, of this operation.

Returns
TypeDescription
Google\Cloud\Firestore\Admin\V1\Progress|null

hasProgressDocuments

clearProgressDocuments

setProgressDocuments

The progress, in documents, of this operation.

Parameter
NameDescription
var Google\Cloud\Firestore\Admin\V1\Progress
Returns
TypeDescription
$this

getProgressBytes

The progress, in bytes, of this operation.

Returns
TypeDescription
Google\Cloud\Firestore\Admin\V1\Progress|null

hasProgressBytes

clearProgressBytes

setProgressBytes

The progress, in bytes, of this operation.

Parameter
NameDescription
var Google\Cloud\Firestore\Admin\V1\Progress
Returns
TypeDescription
$this

getCollectionIds

Which collection ids are being exported.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setCollectionIds

Which collection ids are being exported.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getOutputUriPrefix

Where the documents are being exported to.

Returns
TypeDescription
string

setOutputUriPrefix

Where the documents are being exported to.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNamespaceIds

Which namespace ids are being exported.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setNamespaceIds

Which namespace ids are being exported.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getSnapshotTime

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
TypeDescription
Google\Protobuf\Timestamp|null

hasSnapshotTime

clearSnapshotTime

setSnapshotTime

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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this