Cloud Firestore V1 Client - Class FieldOperationMetadata (1.40.0)

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

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

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

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

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.
`↳ field`	`string` The field resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
`↳ index_config_deltas`	`array<Google\Cloud\Firestore\Admin\V1\FieldOperationMetadata\IndexConfigDelta>` A list of IndexConfigDelta, which describe the intent of this 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.
`↳ ttl_config_delta`	`Google\Cloud\Firestore\Admin\V1\FieldOperationMetadata\TtlConfigDelta` Describes the deltas of TTL configuration.

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`

getField

The field resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Returns
Type	Description
`string`

setField

The field resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getIndexConfigDeltas

A list of IndexConfigDelta, which describe the intent of this operation.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setIndexConfigDeltas

A list of IndexConfigDelta, which describe the intent of this operation.

Parameter
Name	Description
`var`	`array<Google\Cloud\Firestore\Admin\V1\FieldOperationMetadata\IndexConfigDelta>`

Returns
Type	Description
`$this`

getState

The state of the operation.

Returns
Type	Description
`int`

setState

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`

getTtlConfigDelta

Describes the deltas of TTL configuration.

Returns
Type	Description
`Google\Cloud\Firestore\Admin\V1\FieldOperationMetadata\TtlConfigDelta\|null`

hasTtlConfigDelta

clearTtlConfigDelta

setTtlConfigDelta

Describes the deltas of TTL configuration.

Parameter
Name	Description
`var`	`Google\Cloud\Firestore\Admin\V1\FieldOperationMetadata\TtlConfigDelta`

Returns
Type	Description
`$this`