Firestore Admin v1 API - Class FieldOperationMetadata (3.5.0)

public sealed class FieldOperationMetadata : IMessage<FieldOperationMetadata>, IEquatable<FieldOperationMetadata>, IDeepCloneable<FieldOperationMetadata>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore Admin v1 API class FieldOperationMetadata.

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].

Inheritance

object > FieldOperationMetadata

Implements

IMessage FieldOperationMetadata, IEquatable FieldOperationMetadata, IDeepCloneable FieldOperationMetadata, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

FieldOperationMetadata()

public FieldOperationMetadata()

FieldOperationMetadata(FieldOperationMetadata)

public FieldOperationMetadata(FieldOperationMetadata other)

Parameter
Name	Description
`other`	`FieldOperationMetadata`

Properties

EndTime

public Timestamp EndTime { get; set; }

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

Property Value
Type	Description
`Timestamp`

Field

public string Field { get; set; }

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

Property Value
Type	Description
`string`

IndexConfigDeltas

public RepeatedField<FieldOperationMetadata.Types.IndexConfigDelta> IndexConfigDeltas { get; }

A list of [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this operation.

Property Value
Type	Description
`RepeatedFieldFieldOperationMetadataTypesIndexConfigDelta`

ProgressBytes

public Progress ProgressBytes { get; set; }

The progress, in bytes, of this operation.

Property Value
Type	Description
`Progress`

ProgressDocuments

public Progress ProgressDocuments { get; set; }

The progress, in documents, of this operation.

Property Value
Type	Description
`Progress`

StartTime

public Timestamp StartTime { get; set; }

The time this operation started.

Property Value
Type	Description
`Timestamp`

State

public OperationState State { get; set; }

The state of the operation.

Property Value
Type	Description
`OperationState`

TtlConfigDelta

public FieldOperationMetadata.Types.TtlConfigDelta TtlConfigDelta { get; set; }

Describes the deltas of TTL configuration.

Property Value
Type	Description
`FieldOperationMetadataTypesTtlConfigDelta`