Interface FieldOperationMetadataOrBuilder (3.24.3) 

public interface FieldOperationMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEndTime()

public abstract Timestamp getEndTime()

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

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public abstract TimestampOrBuilder getEndTimeOrBuilder()

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

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
TimestampOrBuilder

getField()

public abstract String 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 field = 3;

Returns
Type Description
String

The field.

getFieldBytes()

public abstract ByteString getFieldBytes()

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

string field = 3;

Returns
Type Description
ByteString

The bytes for field.

getIndexConfigDeltas(int index)

public abstract FieldOperationMetadata.IndexConfigDelta getIndexConfigDeltas(int index)

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

repeated .google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta index_config_deltas = 4;

Parameter
Name Description
index int
Returns
Type Description
FieldOperationMetadata.IndexConfigDelta

getIndexConfigDeltasCount()

public abstract int getIndexConfigDeltasCount()

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

repeated .google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta index_config_deltas = 4;

Returns
Type Description
int

getIndexConfigDeltasList()

public abstract List<FieldOperationMetadata.IndexConfigDelta> getIndexConfigDeltasList()

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

repeated .google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta index_config_deltas = 4;

Returns
Type Description
List<IndexConfigDelta>

getIndexConfigDeltasOrBuilder(int index)

public abstract FieldOperationMetadata.IndexConfigDeltaOrBuilder getIndexConfigDeltasOrBuilder(int index)

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

repeated .google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta index_config_deltas = 4;

Parameter
Name Description
index int
Returns
Type Description
FieldOperationMetadata.IndexConfigDeltaOrBuilder

getIndexConfigDeltasOrBuilderList()

public abstract List<? extends FieldOperationMetadata.IndexConfigDeltaOrBuilder> getIndexConfigDeltasOrBuilderList()

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

repeated .google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta index_config_deltas = 4;

Returns
Type Description
List<? extends com.google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDeltaOrBuilder>

getProgressBytes()

public abstract Progress getProgressBytes()

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 7;

Returns
Type Description
Progress

The progressBytes.

getProgressBytesOrBuilder()

public abstract ProgressOrBuilder getProgressBytesOrBuilder()

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 7;

Returns
Type Description
ProgressOrBuilder

getProgressDocuments()

public abstract Progress getProgressDocuments()

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 6;

Returns
Type Description
Progress

The progressDocuments.

getProgressDocumentsOrBuilder()

public abstract ProgressOrBuilder getProgressDocumentsOrBuilder()

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 6;

Returns
Type Description
ProgressOrBuilder

getStartTime()

public abstract Timestamp getStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
TimestampOrBuilder

getState()

public abstract OperationState getState()

The state of the operation.

.google.firestore.admin.v1.OperationState state = 5;

Returns
Type Description
OperationState

The state.

getStateValue()

public abstract int getStateValue()

The state of the operation.

.google.firestore.admin.v1.OperationState state = 5;

Returns
Type Description
int

The enum numeric value on the wire for state.

getTtlConfigDelta()

public abstract FieldOperationMetadata.TtlConfigDelta getTtlConfigDelta()

Describes the deltas of TTL configuration.

.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta ttl_config_delta = 8;

Returns
Type Description
FieldOperationMetadata.TtlConfigDelta

The ttlConfigDelta.

getTtlConfigDeltaOrBuilder()

public abstract FieldOperationMetadata.TtlConfigDeltaOrBuilder getTtlConfigDeltaOrBuilder()

Describes the deltas of TTL configuration.

.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta ttl_config_delta = 8;

Returns
Type Description
FieldOperationMetadata.TtlConfigDeltaOrBuilder

hasEndTime()

public abstract boolean hasEndTime()

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

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
boolean

Whether the endTime field is set.

hasProgressBytes()

public abstract boolean hasProgressBytes()

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 7;

Returns
Type Description
boolean

Whether the progressBytes field is set.

hasProgressDocuments()

public abstract boolean hasProgressDocuments()

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 6;

Returns
Type Description
boolean

Whether the progressDocuments field is set.

hasStartTime()

public abstract boolean hasStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
boolean

Whether the startTime field is set.

hasTtlConfigDelta()

public abstract boolean hasTtlConfigDelta()

Describes the deltas of TTL configuration.

.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta ttl_config_delta = 8;

Returns
Type Description
boolean

Whether the ttlConfigDelta field is set.