public final class IndexOperationMetadata extends GeneratedMessageV3 implements IndexOperationMetadataOrBuilder
Metadata for google.longrunning.Operation results from
FirestoreAdmin.CreateIndex.
Protobuf type google.firestore.admin.v1.IndexOperationMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
public static final int END_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int INDEX_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 | |
Static Methods
public static IndexOperationMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static IndexOperationMetadata.Builder newBuilder()
public static IndexOperationMetadata.Builder newBuilder(IndexOperationMetadata prototype)
public static IndexOperationMetadata parseDelimitedFrom(InputStream input)
public static IndexOperationMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static IndexOperationMetadata parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static IndexOperationMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static IndexOperationMetadata parseFrom(ByteString data)
public static IndexOperationMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static IndexOperationMetadata parseFrom(CodedInputStream input)
public static IndexOperationMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static IndexOperationMetadata parseFrom(InputStream input)
public static IndexOperationMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static IndexOperationMetadata parseFrom(ByteBuffer data)
public static IndexOperationMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<IndexOperationMetadata> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public IndexOperationMetadata 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 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.
|
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.
|
public Parser<IndexOperationMetadata> getParserForType()
Overrides
public Progress getProgressBytes()
The progress, in bytes, of this operation.
.google.firestore.admin.v1.Progress progress_bytes = 6;
| Returns |
|---|
| Type | Description |
Progress | The progressBytes.
|
public ProgressOrBuilder getProgressBytesOrBuilder()
The progress, in bytes, of this operation.
.google.firestore.admin.v1.Progress progress_bytes = 6;
public Progress getProgressDocuments()
The progress, in documents, of this operation.
.google.firestore.admin.v1.Progress progress_documents = 5;
| Returns |
|---|
| Type | Description |
Progress | The progressDocuments.
|
public ProgressOrBuilder getProgressDocumentsOrBuilder()
The progress, in documents, of this operation.
.google.firestore.admin.v1.Progress progress_documents = 5;
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 = 4;
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.
|
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 = 6;
| 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 = 5;
| 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.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public IndexOperationMetadata.Builder newBuilderForType()
protected IndexOperationMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public IndexOperationMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
