Package com.google.firestore.admin.v1

Interface IndexOperationMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
IndexOperationMetadata, IndexOperationMetadata.Builder
@Generated public interface IndexOperationMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Timestamp
    getEndTime()
    The time this operation completed.
    com.google.protobuf.TimestampOrBuilder
    getEndTimeOrBuilder()
    The time this operation completed.
    String
    getIndex()
    The index resource that this operation is acting on.
    com.google.protobuf.ByteString
    getIndexBytes()
    The index resource that this operation is acting on.
    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.
    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.
    boolean
    hasEndTime()
    The time this operation completed.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasStartTime

      boolean hasStartTime()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;
      Returns:
      Whether the startTime field is set.

    • getStartTime

      com.google.protobuf.Timestamp getStartTime()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       The time this operation started.
      .google.protobuf.Timestamp start_time = 1;

    • hasEndTime

      boolean hasEndTime()
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;
      Returns:
      Whether the endTime field is set.

    • getEndTime

      com.google.protobuf.Timestamp getEndTime()
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
       The time this operation completed. Will be unset if operation still in
 progress.
      .google.protobuf.Timestamp end_time = 2;

    • getIndex

      String getIndex()
       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:
      The index.

    • getIndexBytes

      com.google.protobuf.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:
      The bytes for index.

    • getStateValue

      int getStateValue()
       The state of the operation.
      .google.firestore.admin.v1.OperationState state = 4;
      Returns:
      The enum numeric value on the wire for state.

    • getState

      OperationState getState()
       The state of the operation.
      .google.firestore.admin.v1.OperationState state = 4;
      Returns:
      The state.

    • hasProgressDocuments

      boolean hasProgressDocuments()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 5;
      Returns:
      Whether the progressDocuments field is set.

    • getProgressDocuments

      Progress getProgressDocuments()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 5;
      Returns:
      The progressDocuments.

    • getProgressDocumentsOrBuilder

      ProgressOrBuilder getProgressDocumentsOrBuilder()
       The progress, in documents, of this operation.
      .google.firestore.admin.v1.Progress progress_documents = 5;

    • hasProgressBytes

      boolean hasProgressBytes()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 6;
      Returns:
      Whether the progressBytes field is set.

    • getProgressBytes

      Progress getProgressBytes()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 6;
      Returns:
      The progressBytes.

    • getProgressBytesOrBuilder

      ProgressOrBuilder getProgressBytesOrBuilder()
       The progress, in bytes, of this operation.
      .google.firestore.admin.v1.Progress progress_bytes = 6;