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
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 |
static class |
FieldOperationMetadata.TtlConfigDelta
Information about an TTL configuration change.
|
static interface |
FieldOperationMetadata.TtlConfigDeltaOrBuilder |
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
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 |
static int |
TTL_CONFIG_DELTA_FIELD_NUMBER |
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.
|
FieldOperationMetadata.TtlConfigDelta |
getTtlConfigDelta()
Describes the deltas of TTL configuration.
|
FieldOperationMetadata.TtlConfigDeltaOrBuilder |
getTtlConfigDeltaOrBuilder()
Describes the deltas of TTL configuration.
|
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.
|
boolean |
hasTtlConfigDelta()
Describes the deltas of TTL configuration.
|
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) |
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
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int START_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
public static final int FIELD_FIELD_NUMBER
public static final int INDEX_CONFIG_DELTAS_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int PROGRESS_DOCUMENTS_FIELD_NUMBER
public static final int PROGRESS_BYTES_FIELD_NUMBER
public static final int TTL_CONFIG_DELTA_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public boolean hasStartTime()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
hasStartTime
in interface FieldOperationMetadataOrBuilder
public com.google.protobuf.Timestamp getStartTime()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
getStartTime
in interface FieldOperationMetadataOrBuilder
public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
getStartTimeOrBuilder
in interface FieldOperationMetadataOrBuilder
public boolean hasEndTime()
The time this operation completed. Will be unset if operation still in progress.
.google.protobuf.Timestamp end_time = 2;
hasEndTime
in interface FieldOperationMetadataOrBuilder
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;
getEndTime
in interface FieldOperationMetadataOrBuilder
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;
getEndTimeOrBuilder
in interface FieldOperationMetadataOrBuilder
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;
getField
in interface FieldOperationMetadataOrBuilder
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;
getFieldBytes
in interface FieldOperationMetadataOrBuilder
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;
getIndexConfigDeltasList
in interface FieldOperationMetadataOrBuilder
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;
getIndexConfigDeltasOrBuilderList
in interface FieldOperationMetadataOrBuilder
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;
getIndexConfigDeltasCount
in interface FieldOperationMetadataOrBuilder
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;
getIndexConfigDeltas
in interface FieldOperationMetadataOrBuilder
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;
getIndexConfigDeltasOrBuilder
in interface FieldOperationMetadataOrBuilder
public int getStateValue()
The state of the operation.
.google.firestore.admin.v1.OperationState state = 5;
getStateValue
in interface FieldOperationMetadataOrBuilder
public OperationState getState()
The state of the operation.
.google.firestore.admin.v1.OperationState state = 5;
getState
in interface FieldOperationMetadataOrBuilder
public boolean hasProgressDocuments()
The progress, in documents, of this operation.
.google.firestore.admin.v1.Progress progress_documents = 6;
hasProgressDocuments
in interface FieldOperationMetadataOrBuilder
public Progress getProgressDocuments()
The progress, in documents, of this operation.
.google.firestore.admin.v1.Progress progress_documents = 6;
getProgressDocuments
in interface FieldOperationMetadataOrBuilder
public ProgressOrBuilder getProgressDocumentsOrBuilder()
The progress, in documents, of this operation.
.google.firestore.admin.v1.Progress progress_documents = 6;
getProgressDocumentsOrBuilder
in interface FieldOperationMetadataOrBuilder
public boolean hasProgressBytes()
The progress, in bytes, of this operation.
.google.firestore.admin.v1.Progress progress_bytes = 7;
hasProgressBytes
in interface FieldOperationMetadataOrBuilder
public Progress getProgressBytes()
The progress, in bytes, of this operation.
.google.firestore.admin.v1.Progress progress_bytes = 7;
getProgressBytes
in interface FieldOperationMetadataOrBuilder
public ProgressOrBuilder getProgressBytesOrBuilder()
The progress, in bytes, of this operation.
.google.firestore.admin.v1.Progress progress_bytes = 7;
getProgressBytesOrBuilder
in interface FieldOperationMetadataOrBuilder
public boolean hasTtlConfigDelta()
Describes the deltas of TTL configuration.
.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta ttl_config_delta = 8;
hasTtlConfigDelta
in interface FieldOperationMetadataOrBuilder
public FieldOperationMetadata.TtlConfigDelta getTtlConfigDelta()
Describes the deltas of TTL configuration.
.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta ttl_config_delta = 8;
getTtlConfigDelta
in interface FieldOperationMetadataOrBuilder
public FieldOperationMetadata.TtlConfigDeltaOrBuilder getTtlConfigDeltaOrBuilder()
Describes the deltas of TTL configuration.
.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta ttl_config_delta = 8;
getTtlConfigDeltaOrBuilder
in interface FieldOperationMetadataOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static FieldOperationMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FieldOperationMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FieldOperationMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FieldOperationMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FieldOperationMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FieldOperationMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FieldOperationMetadata parseFrom(InputStream input) throws IOException
IOException
public static FieldOperationMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static FieldOperationMetadata parseDelimitedFrom(InputStream input) throws IOException
IOException
public static FieldOperationMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static FieldOperationMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static FieldOperationMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public FieldOperationMetadata.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static FieldOperationMetadata.Builder newBuilder()
public static FieldOperationMetadata.Builder newBuilder(FieldOperationMetadata prototype)
public FieldOperationMetadata.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected FieldOperationMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static FieldOperationMetadata getDefaultInstance()
public static com.google.protobuf.Parser<FieldOperationMetadata> parser()
public com.google.protobuf.Parser<FieldOperationMetadata> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public FieldOperationMetadata getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2023 Google LLC. All rights reserved.