com.google.firestore.admin.v1

Class IndexOperationMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.admin.v1.IndexOperationMetadata

All Implemented Interfaces:

IndexOperationMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class IndexOperationMetadata
extends com.google.protobuf.GeneratedMessageV3
implements IndexOperationMetadataOrBuilder

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

Protobuf type google.firestore.admin.v1.IndexOperationMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexOperationMetadata.Builder Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	END_TIME_FIELD_NUMBER
static int	INDEX_FIELD_NUMBER
static int	PROGRESS_BYTES_FIELD_NUMBER
static int	PROGRESS_DOCUMENTS_FIELD_NUMBER
static int	START_TIME_FIELD_NUMBER
static int	STATE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static IndexOperationMetadata	getDefaultInstance()
IndexOperationMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Timestamp	getEndTime() The time this operation completed.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() The time this operation completed.
String	getIndex() The index resource that this operation is acting on.
com.google.protobuf.ByteString	getIndexBytes() The index resource that this operation is acting on.
com.google.protobuf.Parser<IndexOperationMetadata>	getParserForType()
Progress	getProgressBytes() The progress, in bytes, of this operation.
ProgressOrBuilder	getProgressBytesOrBuilder() The progress, in bytes, of this operation.
Progress	getProgressDocuments() The progress, in documents, of this operation.
ProgressOrBuilder	getProgressDocumentsOrBuilder() The progress, in documents, of this operation.
int	getSerializedSize()
com.google.protobuf.Timestamp	getStartTime() The time this operation started.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() The time this operation started.
OperationState	getState() The state of the operation.
int	getStateValue() The state of the operation.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasEndTime() The time this operation completed.
int	hashCode()
boolean	hasProgressBytes() The progress, in bytes, of this operation.
boolean	hasProgressDocuments() The progress, in documents, of this operation.
boolean	hasStartTime() The time this operation started.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static IndexOperationMetadata.Builder	newBuilder()
static IndexOperationMetadata.Builder	newBuilder(IndexOperationMetadata prototype)
IndexOperationMetadata.Builder	newBuilderForType()
protected IndexOperationMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static IndexOperationMetadata	parseDelimitedFrom(InputStream input)
static IndexOperationMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static IndexOperationMetadata	parseFrom(byte[] data)
static IndexOperationMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static IndexOperationMetadata	parseFrom(ByteBuffer data)
static IndexOperationMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static IndexOperationMetadata	parseFrom(com.google.protobuf.ByteString data)
static IndexOperationMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static IndexOperationMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static IndexOperationMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static IndexOperationMetadata	parseFrom(InputStream input)
static IndexOperationMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<IndexOperationMetadata>	parser()
IndexOperationMetadata.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

See Also:

Constant Field Values

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

See Also:

Constant Field Values

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER

See Also:

Constant Field Values

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

PROGRESS_DOCUMENTS_FIELD_NUMBER

public static final int PROGRESS_DOCUMENTS_FIELD_NUMBER

See Also:

Constant Field Values

PROGRESS_BYTES_FIELD_NUMBER

public static final int PROGRESS_BYTES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasStartTime

public boolean hasStartTime()

 The time this operation started.
 

.google.protobuf.Timestamp start_time = 1;

Specified by:

hasStartTime in interface IndexOperationMetadataOrBuilder

Returns:

Whether the startTime field is set.

getStartTime

public com.google.protobuf.Timestamp getStartTime()

 The time this operation started.
 

.google.protobuf.Timestamp start_time = 1;

Specified by:

getStartTime in interface IndexOperationMetadataOrBuilder

Returns:

The startTime.

getStartTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 The time this operation started.
 

.google.protobuf.Timestamp start_time = 1;

Specified by:

getStartTimeOrBuilder in interface IndexOperationMetadataOrBuilder

hasEndTime

public boolean hasEndTime()

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

.google.protobuf.Timestamp end_time = 2;

Specified by:

hasEndTime in interface IndexOperationMetadataOrBuilder

Returns:

Whether the endTime field is set.

getEndTime

public com.google.protobuf.Timestamp getEndTime()

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

.google.protobuf.Timestamp end_time = 2;

Specified by:

getEndTime in interface IndexOperationMetadataOrBuilder

Returns:

The endTime.

getEndTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

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

.google.protobuf.Timestamp end_time = 2;

Specified by:

getEndTimeOrBuilder in interface IndexOperationMetadataOrBuilder

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;

Specified by:

getIndex in interface IndexOperationMetadataOrBuilder

Returns:

The index.

getIndexBytes

public com.google.protobuf.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;

Specified by:

getIndexBytes in interface IndexOperationMetadataOrBuilder

Returns:

The bytes for index.

getStateValue

public int getStateValue()

 The state of the operation.
 

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

Specified by:

getStateValue in interface IndexOperationMetadataOrBuilder

Returns:

The enum numeric value on the wire for state.

getState

public OperationState getState()

 The state of the operation.
 

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

Specified by:

getState in interface IndexOperationMetadataOrBuilder

Returns:

The state.

hasProgressDocuments

public boolean hasProgressDocuments()

 The progress, in documents, of this operation.
 

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

Specified by:

hasProgressDocuments in interface IndexOperationMetadataOrBuilder

Returns:

Whether the progressDocuments field is set.

getProgressDocuments

public Progress getProgressDocuments()

 The progress, in documents, of this operation.
 

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

Specified by:

getProgressDocuments in interface IndexOperationMetadataOrBuilder

Returns:

The progressDocuments.

getProgressDocumentsOrBuilder

public ProgressOrBuilder getProgressDocumentsOrBuilder()

 The progress, in documents, of this operation.
 

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

Specified by:

getProgressDocumentsOrBuilder in interface IndexOperationMetadataOrBuilder

hasProgressBytes

public boolean hasProgressBytes()

 The progress, in bytes, of this operation.
 

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

Specified by:

hasProgressBytes in interface IndexOperationMetadataOrBuilder

Returns:

Whether the progressBytes field is set.

getProgressBytes

public Progress getProgressBytes()

 The progress, in bytes, of this operation.
 

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

Specified by:

getProgressBytes in interface IndexOperationMetadataOrBuilder

Returns:

The progressBytes.

getProgressBytesOrBuilder

public ProgressOrBuilder getProgressBytesOrBuilder()

 The progress, in bytes, of this operation.
 

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

Specified by:

getProgressBytesOrBuilder in interface IndexOperationMetadataOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static IndexOperationMetadata parseFrom(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static IndexOperationMetadata parseFrom(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static IndexOperationMetadata parseFrom(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static IndexOperationMetadata parseFrom(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static IndexOperationMetadata parseFrom(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static IndexOperationMetadata parseFrom(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static IndexOperationMetadata parseFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static IndexOperationMetadata parseFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static IndexOperationMetadata parseDelimitedFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static IndexOperationMetadata parseDelimitedFrom(InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

parseFrom

public static IndexOperationMetadata parseFrom(com.google.protobuf.CodedInputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static IndexOperationMetadata parseFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

newBuilderForType

public IndexOperationMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static IndexOperationMetadata.Builder newBuilder()

newBuilder

public static IndexOperationMetadata.Builder newBuilder(IndexOperationMetadata prototype)

toBuilder

public IndexOperationMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected IndexOperationMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static IndexOperationMetadata getDefaultInstance()

parser

public static com.google.protobuf.Parser<IndexOperationMetadata> parser()

getParserForType

public com.google.protobuf.Parser<IndexOperationMetadata> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public IndexOperationMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder