com.google.firestore.admin.v1

Class FieldOperationMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.admin.v1.FieldOperationMetadata

All Implemented Interfaces:

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

public final class FieldOperationMetadata
extends com.google.protobuf.GeneratedMessageV3
implements FieldOperationMetadataOrBuilder

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

Protobuf type google.firestore.admin.v1.FieldOperationMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldOperationMetadata.Builder Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
static class	FieldOperationMetadata.IndexConfigDelta Information about an index configuration change.
static interface	FieldOperationMetadata.IndexConfigDeltaOrBuilder

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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	FIELD_FIELD_NUMBER
static int	INDEX_CONFIG_DELTAS_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 FieldOperationMetadata	getDefaultInstance()
FieldOperationMetadata	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	getField() The field resource that this operation is acting on.
com.google.protobuf.ByteString	getFieldBytes() The field resource that this operation is acting on.
FieldOperationMetadata.IndexConfigDelta	getIndexConfigDeltas(int index) A list of [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this operation.
int	getIndexConfigDeltasCount() A list of [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this operation.
List<FieldOperationMetadata.IndexConfigDelta>	getIndexConfigDeltasList() A list of [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this operation.
FieldOperationMetadata.IndexConfigDeltaOrBuilder	getIndexConfigDeltasOrBuilder(int index) A list of [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this operation.
List<? extends FieldOperationMetadata.IndexConfigDeltaOrBuilder>	getIndexConfigDeltasOrBuilderList() A list of [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this operation.
com.google.protobuf.Parser<FieldOperationMetadata>	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 FieldOperationMetadata.Builder	newBuilder()
static FieldOperationMetadata.Builder	newBuilder(FieldOperationMetadata prototype)
FieldOperationMetadata.Builder	newBuilderForType()
protected FieldOperationMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FieldOperationMetadata	parseDelimitedFrom(InputStream input)
static FieldOperationMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FieldOperationMetadata	parseFrom(byte[] data)
static FieldOperationMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FieldOperationMetadata	parseFrom(ByteBuffer data)
static FieldOperationMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FieldOperationMetadata	parseFrom(com.google.protobuf.ByteString data)
static FieldOperationMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FieldOperationMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static FieldOperationMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FieldOperationMetadata	parseFrom(InputStream input)
static FieldOperationMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FieldOperationMetadata>	parser()
FieldOperationMetadata.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, makeExtensionsImmutable, 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

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER

See Also:

Constant Field Values

INDEX_CONFIG_DELTAS_FIELD_NUMBER

public static final int INDEX_CONFIG_DELTAS_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 FieldOperationMetadataOrBuilder

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 FieldOperationMetadataOrBuilder

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 FieldOperationMetadataOrBuilder

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 FieldOperationMetadataOrBuilder

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 FieldOperationMetadataOrBuilder

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 FieldOperationMetadataOrBuilder

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;

Specified by:

getField in interface FieldOperationMetadataOrBuilder

Returns:

The field.

getFieldBytes

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

Specified by:

getFieldBytes in interface FieldOperationMetadataOrBuilder

Returns:

The bytes for field.

getIndexConfigDeltasList

public List<FieldOperationMetadata.IndexConfigDelta> getIndexConfigDeltasList()

 A list of [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this
 operation.
 

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

Specified by:

getIndexConfigDeltasList in interface FieldOperationMetadataOrBuilder

getIndexConfigDeltasOrBuilderList

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

 A list of [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this
 operation.
 

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

Specified by:

getIndexConfigDeltasOrBuilderList in interface FieldOperationMetadataOrBuilder

getIndexConfigDeltasCount

public int getIndexConfigDeltasCount()

 A list of [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this
 operation.
 

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

Specified by:

getIndexConfigDeltasCount in interface FieldOperationMetadataOrBuilder

getIndexConfigDeltas

public FieldOperationMetadata.IndexConfigDelta getIndexConfigDeltas(int index)

 A list of [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this
 operation.
 

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

Specified by:

getIndexConfigDeltas in interface FieldOperationMetadataOrBuilder

getIndexConfigDeltasOrBuilder

public FieldOperationMetadata.IndexConfigDeltaOrBuilder getIndexConfigDeltasOrBuilder(int index)

 A list of [IndexConfigDelta][google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this
 operation.
 

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

Specified by:

getIndexConfigDeltasOrBuilder in interface FieldOperationMetadataOrBuilder

getStateValue

public int getStateValue()

 The state of the operation.
 

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

Specified by:

getStateValue in interface FieldOperationMetadataOrBuilder

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

Specified by:

getState in interface FieldOperationMetadataOrBuilder

Returns:

The state.

hasProgressDocuments

public boolean hasProgressDocuments()

 The progress, in documents, of this operation.
 

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

Specified by:

hasProgressDocuments in interface FieldOperationMetadataOrBuilder

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

Specified by:

getProgressDocuments in interface FieldOperationMetadataOrBuilder

Returns:

The progressDocuments.

getProgressDocumentsOrBuilder

public ProgressOrBuilder getProgressDocumentsOrBuilder()

 The progress, in documents, of this operation.
 

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

Specified by:

getProgressDocumentsOrBuilder in interface FieldOperationMetadataOrBuilder

hasProgressBytes

public boolean hasProgressBytes()

 The progress, in bytes, of this operation.
 

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

Specified by:

hasProgressBytes in interface FieldOperationMetadataOrBuilder

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 = 7;

Specified by:

getProgressBytes in interface FieldOperationMetadataOrBuilder

Returns:

The progressBytes.

getProgressBytesOrBuilder

public ProgressOrBuilder getProgressBytesOrBuilder()

 The progress, in bytes, of this operation.
 

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

Specified by:

getProgressBytesOrBuilder in interface FieldOperationMetadataOrBuilder

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 FieldOperationMetadata parseFrom(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FieldOperationMetadata parseFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static FieldOperationMetadata parseDelimitedFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public FieldOperationMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FieldOperationMetadata.Builder newBuilder()

newBuilder

public static FieldOperationMetadata.Builder newBuilder(FieldOperationMetadata prototype)

toBuilder

public FieldOperationMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FieldOperationMetadata getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<FieldOperationMetadata> 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 FieldOperationMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder