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 \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ start_time
↳ 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
↳ progress_bytes
↳ ttl_config_delta
Google\Cloud\Firestore\Admin\V1\FieldOperationMetadata\TtlConfigDelta
Describes the deltas of TTL configuration.
getStartTime
The time this operation started.
hasStartTime
clearStartTime
setStartTime
The time this operation started.
$this
getEndTime
The time this operation completed. Will be unset if operation still in progress.
hasEndTime
clearEndTime
setEndTime
The time this operation completed. Will be unset if operation still in progress.
$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}
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}
var
string
$this
getIndexConfigDeltas
A list of IndexConfigDelta , which describe the intent of this operation.
setIndexConfigDeltas
A list of IndexConfigDelta , which describe the intent of this operation.
$this
getState
The state of the operation.
int
setState
The state of the operation.
var
int
$this
getProgressDocuments
The progress, in documents, of this operation.
hasProgressDocuments
clearProgressDocuments
setProgressDocuments
The progress, in documents, of this operation.
$this
getProgressBytes
The progress, in bytes, of this operation.
hasProgressBytes
clearProgressBytes
setProgressBytes
The progress, in bytes, of this operation.
$this
getTtlConfigDelta
Describes the deltas of TTL configuration.
hasTtlConfigDelta
clearTtlConfigDelta
setTtlConfigDelta
Describes the deltas of TTL configuration.
$this
