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
Methods
__construct
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 |
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 entities are being exported to. |
getStartTime
The time this operation started.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
The time this operation started.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
The time this operation completed. Will be unset if operation still in progress.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
The time this operation completed. Will be unset if operation still in progress.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOperationState
The state of the export operation.
| Returns | |
|---|---|
| Type | Description |
int | |
setOperationState
The state of the export operation.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProgressDocuments
The progress, in documents, of this operation.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\Admin\V1\Progress|null | |
hasProgressDocuments
clearProgressDocuments
setProgressDocuments
The progress, in documents, of this operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\Admin\V1\Progress
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProgressBytes
The progress, in bytes, of this operation.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\Admin\V1\Progress|null | |
hasProgressBytes
clearProgressBytes
setProgressBytes
The progress, in bytes, of this operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\Admin\V1\Progress
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCollectionIds
Which collection ids are being exported.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setCollectionIds
Which collection ids are being exported.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOutputUriPrefix
Where the entities are being exported to.
| Returns | |
|---|---|
| Type | Description |
string | |
setOutputUriPrefix
Where the entities are being exported to.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |