Cloud Firestore V1 Client - Class FieldOperationMetadata (1.28.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

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.

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

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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getIndexConfigDeltas

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setIndexConfigDeltas

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

Parameter
NameDescription
var array<Google\Cloud\Firestore\Admin\V1\FieldOperationMetadata\IndexConfigDelta>
Returns
TypeDescription
$this

getState

The state of the operation.

Returns
TypeDescription
int

setState

The state of the 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

getTtlConfigDelta

Describes the deltas of TTL configuration.

Returns
TypeDescription
Google\Cloud\Firestore\Admin\V1\FieldOperationMetadata\TtlConfigDelta|null

hasTtlConfigDelta

clearTtlConfigDelta

setTtlConfigDelta

Describes the deltas of TTL configuration.

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