Reference documentation and code samples for the Cloud Firestore V1 Client class BulkDeleteDocumentsMetadata.
Metadata for google.longrunning.Operation results from FirestoreAdmin.BulkDeleteDocuments.
Generated from protobuf message google.firestore.admin.v1.BulkDeleteDocumentsMetadata
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
__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 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
The ids of the collection groups that are being deleted. |
↳ namespace_ids |
array
Which namespace ids are being deleted. |
↳ snapshot_time |
Google\Protobuf\Timestamp
The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit). |
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 operation.
| Returns | |
|---|---|
| Type | Description |
int |
|
setOperationState
The state of the 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
The ids of the collection groups that are being deleted.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCollectionIds
The ids of the collection groups that are being deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNamespaceIds
Which namespace ids are being deleted.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setNamespaceIds
Which namespace ids are being deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSnapshotTime
The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasSnapshotTime
clearSnapshotTime
setSnapshotTime
The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit).
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|