public final class IndexOperationMetadata extends GeneratedMessageV3 implements IndexOperationMetadataOrBuilder
Metadata for google.longrunning.Operation results from
FirestoreAdmin.CreateIndex.
Protobuf type google.firestore.admin.v1.IndexOperationMetadata
Static Fields
public static final int END_TIME_FIELD_NUMBER
Field Value
public static final int INDEX_FIELD_NUMBER
Field Value
public static final int PROGRESS_BYTES_FIELD_NUMBER
Field Value
public static final int PROGRESS_DOCUMENTS_FIELD_NUMBER
Field Value
public static final int START_TIME_FIELD_NUMBER
Field Value
public static final int STATE_FIELD_NUMBER
Field Value
Static Methods
public static IndexOperationMetadata getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static IndexOperationMetadata.Builder newBuilder()
Returns
public static IndexOperationMetadata.Builder newBuilder(IndexOperationMetadata prototype)
Parameter
Returns
public static IndexOperationMetadata parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static IndexOperationMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static IndexOperationMetadata parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
public static IndexOperationMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static IndexOperationMetadata parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static IndexOperationMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static IndexOperationMetadata parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static IndexOperationMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static IndexOperationMetadata parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static IndexOperationMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static IndexOperationMetadata parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static IndexOperationMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<IndexOperationMetadata> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public IndexOperationMetadata getDefaultInstanceForType()
Returns
public Timestamp getEndTime()
The time this operation completed. Will be unset if operation still in
progress.
.google.protobuf.Timestamp end_time = 2;
Returns
public TimestampOrBuilder getEndTimeOrBuilder()
The time this operation completed. Will be unset if operation still in
progress.
.google.protobuf.Timestamp end_time = 2;
Returns
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
public Parser<IndexOperationMetadata> getParserForType()
Returns
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;
Returns
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;
Returns
public int getSerializedSize()
Returns
Overrides
public Timestamp getStartTime()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
Returns
public TimestampOrBuilder getStartTimeOrBuilder()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
Returns
public OperationState getState()
The state of the operation.
.google.firestore.admin.v1.OperationState state = 4;
Returns
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 final UnknownFieldSet getUnknownFields()
Returns
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 = 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
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public IndexOperationMetadata.Builder newBuilderForType()
Returns
protected IndexOperationMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public IndexOperationMetadata.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions