Class IndexOperationMetadata (3.11.0)

public final class IndexOperationMetadata extends GeneratedMessageV3 implements IndexOperationMetadataOrBuilder

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

Protobuf type google.firestore.admin.v1.IndexOperationMetadata

Inheritance

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

Implements

IndexOperationMetadataOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER

Field Value
Type	Description
`int`

PROGRESS_BYTES_FIELD_NUMBER

public static final int PROGRESS_BYTES_FIELD_NUMBER

Field Value
Type	Description
`int`

PROGRESS_DOCUMENTS_FIELD_NUMBER

public static final int PROGRESS_DOCUMENTS_FIELD_NUMBER

Field Value
Type	Description
`int`

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static IndexOperationMetadata getDefaultInstance()

Returns
Type	Description
`IndexOperationMetadata`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static IndexOperationMetadata.Builder newBuilder()

Returns
Type	Description
`IndexOperationMetadata.Builder`

newBuilder(IndexOperationMetadata prototype)

public static IndexOperationMetadata.Builder newBuilder(IndexOperationMetadata prototype)

Parameter
Name	Description
`prototype`	`IndexOperationMetadata`

Returns
Type	Description
`IndexOperationMetadata.Builder`

parseDelimitedFrom(InputStream input)

public static IndexOperationMetadata parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`IndexOperationMetadata`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexOperationMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IndexOperationMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static IndexOperationMetadata parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`IndexOperationMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IndexOperationMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IndexOperationMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static IndexOperationMetadata parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`IndexOperationMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IndexOperationMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IndexOperationMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static IndexOperationMetadata parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`IndexOperationMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexOperationMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IndexOperationMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static IndexOperationMetadata parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`IndexOperationMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexOperationMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IndexOperationMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static IndexOperationMetadata parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`IndexOperationMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IndexOperationMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IndexOperationMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<IndexOperationMetadata> parser()

Returns
Type	Description
`Parser<IndexOperationMetadata>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public IndexOperationMetadata getDefaultInstanceForType()

Returns
Type	Description
`IndexOperationMetadata`

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.

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.

getParserForType()

public Parser<IndexOperationMetadata> getParserForType()

Returns
Type	Description
`Parser<IndexOperationMetadata>`

Overrides

GeneratedMessageV3.getParserForType()

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.

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.

getProgressDocumentsOrBuilder()

public ProgressOrBuilder getProgressDocumentsOrBuilder()

The progress, in documents, of this operation.

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

Returns
Type	Description
`ProgressOrBuilder`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getStartTime()

public Timestamp getStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type	Description
`Timestamp`	The startTime.

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
`UnknownFieldSet`

Overrides

GeneratedMessageV3.getUnknownFields()

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.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public IndexOperationMetadata.Builder newBuilderForType()

Returns
Type	Description
`IndexOperationMetadata.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IndexOperationMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`IndexOperationMetadata.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public IndexOperationMetadata.Builder toBuilder()

Returns
Type	Description
`IndexOperationMetadata.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`