Class IndexOperationMetadata.Builder (3.3.0)

Version 3.3.0

• 3.20.0 (latest)
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static final class IndexOperationMetadata.Builder extends GeneratedMessageV3.Builder<IndexOperationMetadata.Builder> implements IndexOperationMetadataOrBuilder

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

Protobuf type google.firestore.admin.v1.IndexOperationMetadata

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > IndexOperationMetadata.Builder

Implements

IndexOperationMetadataOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public IndexOperationMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
IndexOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public IndexOperationMetadata build()

Returns

Type	Description
IndexOperationMetadata

buildPartial()

public IndexOperationMetadata buildPartial()

Returns

Type	Description
IndexOperationMetadata

clear()

public IndexOperationMetadata.Builder clear()

Returns

Type	Description
IndexOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearEndTime()

public IndexOperationMetadata.Builder clearEndTime()

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

.google.protobuf.Timestamp end_time = 2;

Returns

Type	Description
IndexOperationMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

public IndexOperationMetadata.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
IndexOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIndex()

public IndexOperationMetadata.Builder clearIndex()

The index resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

string index = 3;

Returns

Type	Description
IndexOperationMetadata.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public IndexOperationMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
IndexOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearProgressBytes()

public IndexOperationMetadata.Builder clearProgressBytes()

The progress, in bytes, of this operation.

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

Returns

Type	Description
IndexOperationMetadata.Builder

clearProgressDocuments()

public IndexOperationMetadata.Builder clearProgressDocuments()

The progress, in documents, of this operation.

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

Returns

Type	Description
IndexOperationMetadata.Builder

clearStartTime()

public IndexOperationMetadata.Builder clearStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns

Type	Description
IndexOperationMetadata.Builder

clearState()

public IndexOperationMetadata.Builder clearState()

The state of the operation.

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

Returns

Type	Description
IndexOperationMetadata.Builder	This builder for chaining.

clone()

public IndexOperationMetadata.Builder clone()

Returns

Type	Description
IndexOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public IndexOperationMetadata getDefaultInstanceForType()

Returns

Type	Description
IndexOperationMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEndTime()

public 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.

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

Type	Description
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

Type	Description
TimestampOrBuilder

getIndex()

public String getIndex()

The index resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

string index = 3;

Returns

Type	Description
String	The index.

getIndexBytes()

public ByteString getIndexBytes()

The index resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

string index = 3;

Returns

Type	Description
ByteString	The bytes for index.

getProgressBytes()

public Progress getProgressBytes()

The progress, in bytes, of this operation.

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

Returns

Type	Description
Progress	The progressBytes.

getProgressBytesBuilder()

public Progress.Builder getProgressBytesBuilder()

The progress, in bytes, of this operation.

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

Returns

Type	Description
Progress.Builder

getProgressBytesOrBuilder()

public ProgressOrBuilder getProgressBytesOrBuilder()

The progress, in bytes, of this operation.

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

Returns

Type	Description
ProgressOrBuilder

getProgressDocuments()

public Progress getProgressDocuments()

The progress, in documents, of this operation.

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

Returns

Type	Description
Progress	The progressDocuments.

getProgressDocumentsBuilder()

public Progress.Builder getProgressDocumentsBuilder()

The progress, in documents, of this operation.

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

Returns

Type	Description
Progress.Builder

getProgressDocumentsOrBuilder()

public ProgressOrBuilder getProgressDocumentsOrBuilder()

The progress, in documents, of this operation.

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

Returns

Type	Description
ProgressOrBuilder

getStartTime()

public Timestamp getStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns

Type	Description
Timestamp	The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns

Type	Description
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns

Type	Description
TimestampOrBuilder

getState()

public OperationState getState()

The state of the operation.

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

Returns

Type	Description
OperationState	The state.

getStateValue()

public int getStateValue()

The state of the operation.

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

Returns

Type	Description
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

Type	Description
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 = 6;

Returns

Type	Description
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 = 5;

Returns

Type	Description
boolean	Whether the progressDocuments field is set.

hasStartTime()

public boolean hasStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns

Type	Description
boolean	Whether the startTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeEndTime(Timestamp value)

public IndexOperationMetadata.Builder mergeEndTime(Timestamp value)

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

.google.protobuf.Timestamp end_time = 2;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
IndexOperationMetadata.Builder

mergeFrom(IndexOperationMetadata other)

public IndexOperationMetadata.Builder mergeFrom(IndexOperationMetadata other)

Parameter

Name	Description
other	IndexOperationMetadata

Returns

Type	Description
IndexOperationMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public IndexOperationMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
IndexOperationMetadata.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public IndexOperationMetadata.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
IndexOperationMetadata.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeProgressBytes(Progress value)

public IndexOperationMetadata.Builder mergeProgressBytes(Progress value)

The progress, in bytes, of this operation.

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

Parameter

Name	Description
value	Progress

Returns

Type	Description
IndexOperationMetadata.Builder

mergeProgressDocuments(Progress value)

public IndexOperationMetadata.Builder mergeProgressDocuments(Progress value)

The progress, in documents, of this operation.

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

Parameter

Name	Description
value	Progress

Returns

Type	Description
IndexOperationMetadata.Builder

mergeStartTime(Timestamp value)

public IndexOperationMetadata.Builder mergeStartTime(Timestamp value)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
IndexOperationMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final IndexOperationMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
IndexOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setEndTime(Timestamp value)

public IndexOperationMetadata.Builder setEndTime(Timestamp value)

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

.google.protobuf.Timestamp end_time = 2;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
IndexOperationMetadata.Builder

setEndTime(Timestamp.Builder builderForValue)

public IndexOperationMetadata.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

Name	Description
builderForValue	Builder

Returns

Type	Description
IndexOperationMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public IndexOperationMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
IndexOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIndex(String value)

public IndexOperationMetadata.Builder setIndex(String value)

The index resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

string index = 3;

Parameter

Name	Description
value	String The index to set.

Returns

Type	Description
IndexOperationMetadata.Builder	This builder for chaining.

setIndexBytes(ByteString value)

public IndexOperationMetadata.Builder setIndexBytes(ByteString value)

The index resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

string index = 3;

Parameter

Name	Description
value	ByteString The bytes for index to set.

Returns

Type	Description
IndexOperationMetadata.Builder	This builder for chaining.

setProgressBytes(Progress value)

public IndexOperationMetadata.Builder setProgressBytes(Progress value)

The progress, in bytes, of this operation.

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

Parameter

Name	Description
value	Progress

Returns

Type	Description
IndexOperationMetadata.Builder

setProgressBytes(Progress.Builder builderForValue)

public IndexOperationMetadata.Builder setProgressBytes(Progress.Builder builderForValue)

The progress, in bytes, of this operation.

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

Parameter

Name	Description
builderForValue	Progress.Builder

Returns

Type	Description
IndexOperationMetadata.Builder

setProgressDocuments(Progress value)

public IndexOperationMetadata.Builder setProgressDocuments(Progress value)

The progress, in documents, of this operation.

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

Parameter

Name	Description
value	Progress

Returns

Type	Description
IndexOperationMetadata.Builder

setProgressDocuments(Progress.Builder builderForValue)

public IndexOperationMetadata.Builder setProgressDocuments(Progress.Builder builderForValue)

The progress, in documents, of this operation.

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

Parameter

Name	Description
builderForValue	Progress.Builder

Returns

Type	Description
IndexOperationMetadata.Builder

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
IndexOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setStartTime(Timestamp value)

public IndexOperationMetadata.Builder setStartTime(Timestamp value)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
IndexOperationMetadata.Builder

setStartTime(Timestamp.Builder builderForValue)

public IndexOperationMetadata.Builder setStartTime(Timestamp.Builder builderForValue)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
IndexOperationMetadata.Builder

setState(OperationState value)

public IndexOperationMetadata.Builder setState(OperationState value)

The state of the operation.

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

Parameter

Name	Description
value	OperationState The state to set.

Returns

Type	Description
IndexOperationMetadata.Builder	This builder for chaining.

setStateValue(int value)

public IndexOperationMetadata.Builder setStateValue(int value)

The state of the operation.

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

Parameter

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

Returns

Type	Description
IndexOperationMetadata.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final IndexOperationMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
IndexOperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)