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

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< FieldOperationMetadata\IndexConfigDelta >

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

↳ state
int

The state of the operation.

↳ progress_documents
Progress

The progress, in documents, of this operation.

↳ progress_bytes
Progress

The progress, in bytes, of this operation.

↳ ttl_config_delta
FieldOperationMetadata\TtlConfigDelta

Describes the deltas of TTL configuration.

The time this operation started.

Returns
Type
Description

The time this operation started.

Parameter
Name
Description
Returns
Type
Description
$this

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

Returns
Type
Description

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

Parameter
Name
Description
Returns
Type
Description
$this

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

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

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

Returns
Type
Description

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

Parameter
Name
Description
Returns
Type
Description
$this

The state of the operation.

Returns
Type
Description
int

The state of the operation.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

The progress, in documents, of this operation.

Returns
Type
Description
Progress |null

The progress, in documents, of this operation.

Parameter
Name
Description
var
Returns
Type
Description
$this

The progress, in bytes, of this operation.

Returns
Type
Description
Progress |null

The progress, in bytes, of this operation.

Parameter
Name
Description
var
Returns
Type
Description
$this

Describes the deltas of TTL configuration.

Returns
Type
Description

Describes the deltas of TTL configuration.

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: