Class FieldOperationMetadata.Builder

public static final class FieldOperationMetadata.Builder extends GeneratedMessageV3.Builder<FieldOperationMetadata.Builder> implements FieldOperationMetadataOrBuilder

Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.

Protobuf type google.firestore.admin.v1.FieldOperationMetadata

Methods

addAllIndexConfigDeltas(Iterable<? extends FieldOperationMetadata.IndexConfigDelta> values)

public FieldOperationMetadata.Builder addAllIndexConfigDeltas(Iterable<? extends FieldOperationMetadata.IndexConfigDelta> values)

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

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

Parameter
NameDescription
valuesIterable<? extends com.google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta>
Returns
TypeDescription
FieldOperationMetadata.Builder

addIndexConfigDeltas(FieldOperationMetadata.IndexConfigDelta value)

public FieldOperationMetadata.Builder addIndexConfigDeltas(FieldOperationMetadata.IndexConfigDelta value)

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

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

Parameter
NameDescription
valueFieldOperationMetadata.IndexConfigDelta
Returns
TypeDescription
FieldOperationMetadata.Builder

addIndexConfigDeltas(FieldOperationMetadata.IndexConfigDelta.Builder builderForValue)

public FieldOperationMetadata.Builder addIndexConfigDeltas(FieldOperationMetadata.IndexConfigDelta.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueFieldOperationMetadata.IndexConfigDelta.Builder
Returns
TypeDescription
FieldOperationMetadata.Builder

addIndexConfigDeltas(int index, FieldOperationMetadata.IndexConfigDelta value)

public FieldOperationMetadata.Builder addIndexConfigDeltas(int index, FieldOperationMetadata.IndexConfigDelta value)

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

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

Parameters
NameDescription
indexint
valueFieldOperationMetadata.IndexConfigDelta
Returns
TypeDescription
FieldOperationMetadata.Builder

addIndexConfigDeltas(int index, FieldOperationMetadata.IndexConfigDelta.Builder builderForValue)

public FieldOperationMetadata.Builder addIndexConfigDeltas(int index, FieldOperationMetadata.IndexConfigDelta.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueFieldOperationMetadata.IndexConfigDelta.Builder
Returns
TypeDescription
FieldOperationMetadata.Builder

addIndexConfigDeltasBuilder()

public FieldOperationMetadata.IndexConfigDelta.Builder addIndexConfigDeltasBuilder()

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

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

Returns
TypeDescription
FieldOperationMetadata.IndexConfigDelta.Builder

addIndexConfigDeltasBuilder(int index)

public FieldOperationMetadata.IndexConfigDelta.Builder addIndexConfigDeltasBuilder(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
NameDescription
indexint
Returns
TypeDescription
FieldOperationMetadata.IndexConfigDelta.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FieldOperationMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
FieldOperationMetadata.Builder
Overrides

build()

public FieldOperationMetadata build()
Returns
TypeDescription
FieldOperationMetadata

buildPartial()

public FieldOperationMetadata buildPartial()
Returns
TypeDescription
FieldOperationMetadata

clear()

public FieldOperationMetadata.Builder clear()
Returns
TypeDescription
FieldOperationMetadata.Builder
Overrides

clearEndTime()

public FieldOperationMetadata.Builder clearEndTime()

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

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
FieldOperationMetadata.Builder

clearField()

public FieldOperationMetadata.Builder clearField()

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
TypeDescription
FieldOperationMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FieldOperationMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
FieldOperationMetadata.Builder
Overrides

clearIndexConfigDeltas()

public FieldOperationMetadata.Builder clearIndexConfigDeltas()

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

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

Returns
TypeDescription
FieldOperationMetadata.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public FieldOperationMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
FieldOperationMetadata.Builder
Overrides

clearProgressBytes()

public FieldOperationMetadata.Builder clearProgressBytes()

The progress, in bytes, of this operation.

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

Returns
TypeDescription
FieldOperationMetadata.Builder

clearProgressDocuments()

public FieldOperationMetadata.Builder clearProgressDocuments()

The progress, in documents, of this operation.

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

Returns
TypeDescription
FieldOperationMetadata.Builder

clearStartTime()

public FieldOperationMetadata.Builder clearStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
FieldOperationMetadata.Builder

clearState()

public FieldOperationMetadata.Builder clearState()

The state of the operation.

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

Returns
TypeDescription
FieldOperationMetadata.Builder

This builder for chaining.

clone()

public FieldOperationMetadata.Builder clone()
Returns
TypeDescription
FieldOperationMetadata.Builder
Overrides

getDefaultInstanceForType()

public FieldOperationMetadata getDefaultInstanceForType()
Returns
TypeDescription
FieldOperationMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEndTime()

public Timestamp getEndTime()

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

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

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

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
TimestampOrBuilder

getField()

public 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
TypeDescription
String

The field.

getFieldBytes()

public 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
TypeDescription
ByteString

The bytes for field.

getIndexConfigDeltas(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
FieldOperationMetadata.IndexConfigDelta

getIndexConfigDeltasBuilder(int index)

public FieldOperationMetadata.IndexConfigDelta.Builder getIndexConfigDeltasBuilder(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
NameDescription
indexint
Returns
TypeDescription
FieldOperationMetadata.IndexConfigDelta.Builder

getIndexConfigDeltasBuilderList()

public List<FieldOperationMetadata.IndexConfigDelta.Builder> getIndexConfigDeltasBuilderList()

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

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

Returns
TypeDescription
List<Builder>

getIndexConfigDeltasCount()

public 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
TypeDescription
int

getIndexConfigDeltasList()

public 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
TypeDescription
List<IndexConfigDelta>

getIndexConfigDeltasOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
FieldOperationMetadata.IndexConfigDeltaOrBuilder

getIndexConfigDeltasOrBuilderList()

public 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
TypeDescription
List<? extends com.google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDeltaOrBuilder>

getProgressBytes()

public Progress getProgressBytes()

The progress, in bytes, of this operation.

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

Returns
TypeDescription
Progress

The progressBytes.

getProgressBytesBuilder()

public Progress.Builder getProgressBytesBuilder()

The progress, in bytes, of this operation.

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

Returns
TypeDescription
Progress.Builder

getProgressBytesOrBuilder()

public ProgressOrBuilder getProgressBytesOrBuilder()

The progress, in bytes, of this operation.

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

Returns
TypeDescription
ProgressOrBuilder

getProgressDocuments()

public Progress getProgressDocuments()

The progress, in documents, of this operation.

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

Returns
TypeDescription
Progress

The progressDocuments.

getProgressDocumentsBuilder()

public Progress.Builder getProgressDocumentsBuilder()

The progress, in documents, of this operation.

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

Returns
TypeDescription
Progress.Builder

getProgressDocumentsOrBuilder()

public ProgressOrBuilder getProgressDocumentsOrBuilder()

The progress, in documents, of this operation.

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

Returns
TypeDescription
ProgressOrBuilder

getStartTime()

public Timestamp getStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
TimestampOrBuilder

getState()

public OperationState getState()

The state of the operation.

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

Returns
TypeDescription
OperationState

The state.

getStateValue()

public int getStateValue()

The state of the operation.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

hasEndTime()

public boolean hasEndTime()

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

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasProgressBytes()

public boolean hasProgressBytes()

The progress, in bytes, of this operation.

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

Returns
TypeDescription
boolean

Whether the progressBytes field is set.

hasProgressDocuments()

public boolean hasProgressDocuments()

The progress, in documents, of this operation.

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

Returns
TypeDescription
boolean

Whether the progressDocuments field is set.

hasStartTime()

public boolean hasStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
boolean

Whether the startTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEndTime(Timestamp value)

public FieldOperationMetadata.Builder mergeEndTime(Timestamp value)

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

.google.protobuf.Timestamp end_time = 2;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
FieldOperationMetadata.Builder

mergeFrom(FieldOperationMetadata other)

public FieldOperationMetadata.Builder mergeFrom(FieldOperationMetadata other)
Parameter
NameDescription
otherFieldOperationMetadata
Returns
TypeDescription
FieldOperationMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FieldOperationMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FieldOperationMetadata.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public FieldOperationMetadata.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
FieldOperationMetadata.Builder
Overrides

mergeProgressBytes(Progress value)

public FieldOperationMetadata.Builder mergeProgressBytes(Progress value)

The progress, in bytes, of this operation.

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

Parameter
NameDescription
valueProgress
Returns
TypeDescription
FieldOperationMetadata.Builder

mergeProgressDocuments(Progress value)

public FieldOperationMetadata.Builder mergeProgressDocuments(Progress value)

The progress, in documents, of this operation.

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

Parameter
NameDescription
valueProgress
Returns
TypeDescription
FieldOperationMetadata.Builder

mergeStartTime(Timestamp value)

public FieldOperationMetadata.Builder mergeStartTime(Timestamp value)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
FieldOperationMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FieldOperationMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
FieldOperationMetadata.Builder
Overrides

removeIndexConfigDeltas(int index)

public FieldOperationMetadata.Builder removeIndexConfigDeltas(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
NameDescription
indexint
Returns
TypeDescription
FieldOperationMetadata.Builder

setEndTime(Timestamp value)

public FieldOperationMetadata.Builder setEndTime(Timestamp value)

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

.google.protobuf.Timestamp end_time = 2;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
FieldOperationMetadata.Builder

setEndTime(Timestamp.Builder builderForValue)

public FieldOperationMetadata.Builder setEndTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp end_time = 2;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
FieldOperationMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public FieldOperationMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
FieldOperationMetadata.Builder
Overrides

setField(String value)

public FieldOperationMetadata.Builder setField(String value)

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;

Parameter
NameDescription
valueString

The field to set.

Returns
TypeDescription
FieldOperationMetadata.Builder

This builder for chaining.

setFieldBytes(ByteString value)

public FieldOperationMetadata.Builder setFieldBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for field to set.

Returns
TypeDescription
FieldOperationMetadata.Builder

This builder for chaining.

setIndexConfigDeltas(int index, FieldOperationMetadata.IndexConfigDelta value)

public FieldOperationMetadata.Builder setIndexConfigDeltas(int index, FieldOperationMetadata.IndexConfigDelta value)

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

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

Parameters
NameDescription
indexint
valueFieldOperationMetadata.IndexConfigDelta
Returns
TypeDescription
FieldOperationMetadata.Builder

setIndexConfigDeltas(int index, FieldOperationMetadata.IndexConfigDelta.Builder builderForValue)

public FieldOperationMetadata.Builder setIndexConfigDeltas(int index, FieldOperationMetadata.IndexConfigDelta.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueFieldOperationMetadata.IndexConfigDelta.Builder
Returns
TypeDescription
FieldOperationMetadata.Builder

setProgressBytes(Progress value)

public FieldOperationMetadata.Builder setProgressBytes(Progress value)

The progress, in bytes, of this operation.

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

Parameter
NameDescription
valueProgress
Returns
TypeDescription
FieldOperationMetadata.Builder

setProgressBytes(Progress.Builder builderForValue)

public FieldOperationMetadata.Builder setProgressBytes(Progress.Builder builderForValue)

The progress, in bytes, of this operation.

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

Parameter
NameDescription
builderForValueProgress.Builder
Returns
TypeDescription
FieldOperationMetadata.Builder

setProgressDocuments(Progress value)

public FieldOperationMetadata.Builder setProgressDocuments(Progress value)

The progress, in documents, of this operation.

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

Parameter
NameDescription
valueProgress
Returns
TypeDescription
FieldOperationMetadata.Builder

setProgressDocuments(Progress.Builder builderForValue)

public FieldOperationMetadata.Builder setProgressDocuments(Progress.Builder builderForValue)

The progress, in documents, of this operation.

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

Parameter
NameDescription
builderForValueProgress.Builder
Returns
TypeDescription
FieldOperationMetadata.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FieldOperationMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
FieldOperationMetadata.Builder
Overrides

setStartTime(Timestamp value)

public FieldOperationMetadata.Builder setStartTime(Timestamp value)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
FieldOperationMetadata.Builder

setStartTime(Timestamp.Builder builderForValue)

public FieldOperationMetadata.Builder setStartTime(Timestamp.Builder builderForValue)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
FieldOperationMetadata.Builder

setState(OperationState value)

public FieldOperationMetadata.Builder setState(OperationState value)

The state of the operation.

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

Parameter
NameDescription
valueOperationState

The state to set.

Returns
TypeDescription
FieldOperationMetadata.Builder

This builder for chaining.

setStateValue(int value)

public FieldOperationMetadata.Builder setStateValue(int value)

The state of the operation.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
FieldOperationMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final FieldOperationMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
FieldOperationMetadata.Builder
Overrides