public final class FieldOperationMetadata extends GeneratedMessageV3 implements FieldOperationMetadataOrBuilder
Metadata for google.longrunning.Operation results from
FirestoreAdmin.UpdateField.
Protobuf type google.firestore.admin.v1.FieldOperationMetadata
Static Fields
public static final int END_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int FIELD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int INDEX_CONFIG_DELTAS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PROGRESS_BYTES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PROGRESS_DOCUMENTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int START_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int TTL_CONFIG_DELTA_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static FieldOperationMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static FieldOperationMetadata.Builder newBuilder()
public static FieldOperationMetadata.Builder newBuilder(FieldOperationMetadata prototype)
public static FieldOperationMetadata parseDelimitedFrom(InputStream input)
public static FieldOperationMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FieldOperationMetadata parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static FieldOperationMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FieldOperationMetadata parseFrom(ByteString data)
public static FieldOperationMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FieldOperationMetadata parseFrom(CodedInputStream input)
public static FieldOperationMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static FieldOperationMetadata parseFrom(InputStream input)
public static FieldOperationMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FieldOperationMetadata parseFrom(ByteBuffer data)
public static FieldOperationMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<FieldOperationMetadata> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public FieldOperationMetadata getDefaultInstanceForType()
public Timestamp getEndTime()
The time this operation completed. Will be unset if operation still in
progress.
.google.protobuf.Timestamp end_time = 2;
public TimestampOrBuilder getEndTimeOrBuilder()
The time this operation completed. Will be unset if operation still in
progress.
.google.protobuf.Timestamp end_time = 2;
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;
| Returns |
|---|
| Type | Description |
String | The field.
|
public 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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for field.
|
public FieldOperationMetadata.IndexConfigDelta getIndexConfigDeltas(int index)
A list of IndexConfigDelta, which describe the intent of this
operation.
repeated .google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta index_config_deltas = 4;
| Parameter |
|---|
| Name | Description |
index | int
|
public int getIndexConfigDeltasCount()
A list of IndexConfigDelta, which describe the intent of this
operation.
repeated .google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta index_config_deltas = 4;
| Returns |
|---|
| Type | Description |
int | |
public List<FieldOperationMetadata.IndexConfigDelta> getIndexConfigDeltasList()
A list of IndexConfigDelta, which describe the intent of this
operation.
repeated .google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta index_config_deltas = 4;
public FieldOperationMetadata.IndexConfigDeltaOrBuilder getIndexConfigDeltasOrBuilder(int index)
A list of IndexConfigDelta, which describe the intent of this
operation.
repeated .google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta index_config_deltas = 4;
| Parameter |
|---|
| Name | Description |
index | int
|
public List<? extends FieldOperationMetadata.IndexConfigDeltaOrBuilder> getIndexConfigDeltasOrBuilderList()
A list of IndexConfigDelta, which describe the intent of this
operation.
repeated .google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta index_config_deltas = 4;
| Returns |
|---|
| Type | Description |
List<? extends com.google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDeltaOrBuilder> | |
public Parser<FieldOperationMetadata> getParserForType()
Overrides
public Progress getProgressBytes()
The progress, in bytes, of this operation.
.google.firestore.admin.v1.Progress progress_bytes = 7;
| Returns |
|---|
| Type | Description |
Progress | The progressBytes.
|
public ProgressOrBuilder getProgressBytesOrBuilder()
The progress, in bytes, of this operation.
.google.firestore.admin.v1.Progress progress_bytes = 7;
public Progress getProgressDocuments()
The progress, in documents, of this operation.
.google.firestore.admin.v1.Progress progress_documents = 6;
| Returns |
|---|
| Type | Description |
Progress | The progressDocuments.
|
public ProgressOrBuilder getProgressDocumentsOrBuilder()
The progress, in documents, of this operation.
.google.firestore.admin.v1.Progress progress_documents = 6;
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public Timestamp getStartTime()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
| Returns |
|---|
| Type | Description |
Timestamp | The startTime.
|
public TimestampOrBuilder getStartTimeOrBuilder()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
public OperationState getState()
The state of the operation.
.google.firestore.admin.v1.OperationState state = 5;
public int getStateValue()
The state of the operation.
.google.firestore.admin.v1.OperationState state = 5;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state.
|
public FieldOperationMetadata.TtlConfigDelta getTtlConfigDelta()
Describes the deltas of TTL configuration.
.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta ttl_config_delta = 8;
public FieldOperationMetadata.TtlConfigDeltaOrBuilder getTtlConfigDeltaOrBuilder()
Describes the deltas of TTL configuration.
.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta ttl_config_delta = 8;
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
public boolean hasProgressBytes()
The progress, in bytes, of this operation.
.google.firestore.admin.v1.Progress progress_bytes = 7;
| Returns |
|---|
| Type | Description |
boolean | Whether the progressBytes field is set.
|
public boolean hasProgressDocuments()
The progress, in documents, of this operation.
.google.firestore.admin.v1.Progress progress_documents = 6;
| Returns |
|---|
| Type | Description |
boolean | Whether the progressDocuments field is set.
|
public boolean hasStartTime()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
| Returns |
|---|
| Type | Description |
boolean | Whether the startTime field is set.
|
public boolean hasTtlConfigDelta()
Describes the deltas of TTL configuration.
.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta ttl_config_delta = 8;
| Returns |
|---|
| Type | Description |
boolean | Whether the ttlConfigDelta field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public FieldOperationMetadata.Builder newBuilderForType()
protected FieldOperationMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public FieldOperationMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
