Package com.google.firestore.admin.v1

Interface FieldOperationMetadataOrBuilder

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

  • 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;

    • getField

      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;
      Returns:
      The field.

    • getFieldBytes

      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;
      Returns:
      The bytes for field.

    • getIndexConfigDeltasList

      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;

    • getIndexConfigDeltas

      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;

    • getIndexConfigDeltasCount

      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;

    • getIndexConfigDeltasOrBuilderList

      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;

    • getIndexConfigDeltasOrBuilder

      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;

    • getStateValue

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

    • getState

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

    • hasProgressDocuments

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

    • getProgressDocuments

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

    • getProgressDocumentsOrBuilder

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

    • hasProgressBytes

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

    • getProgressBytes

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

    • getProgressBytesOrBuilder

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

    • hasTtlConfigDelta

      boolean hasTtlConfigDelta()
       Describes the deltas of TTL configuration.
      .google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta ttl_config_delta = 8;
      Returns:
      Whether the ttlConfigDelta field is set.

    • getTtlConfigDelta

      FieldOperationMetadata.TtlConfigDelta getTtlConfigDelta()
       Describes the deltas of TTL configuration.
      .google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta ttl_config_delta = 8;
      Returns:
      The ttlConfigDelta.

    • getTtlConfigDeltaOrBuilder

      FieldOperationMetadata.TtlConfigDeltaOrBuilder getTtlConfigDeltaOrBuilder()
       Describes the deltas of TTL configuration.
      .google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta ttl_config_delta = 8;