Package com.google.firestore.admin.v1

Enum OperationState

java.lang.Object
java.lang.Enum<OperationState>
com.google.firestore.admin.v1.OperationState
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<OperationState>
@Generated public enum OperationState extends Enum<OperationState> implements com.google.protobuf.ProtocolMessageEnum
 Describes the state of the operation.
Protobuf enum google.firestore.admin.v1.OperationState

  • Enum Constant Details

    • OPERATION_STATE_UNSPECIFIED

      public static final OperationState OPERATION_STATE_UNSPECIFIED
       Unspecified.
      OPERATION_STATE_UNSPECIFIED = 0;

    • INITIALIZING

      public static final OperationState INITIALIZING
       Request is being prepared for processing.
      INITIALIZING = 1;

    • PROCESSING

      public static final OperationState PROCESSING
       Request is actively being processed.
      PROCESSING = 2;

    • CANCELLING

      public static final OperationState CANCELLING
       Request is in the process of being cancelled after user called
 google.longrunning.Operations.CancelOperation on the operation.
      CANCELLING = 3;

    • FINALIZING

      public static final OperationState FINALIZING
       Request has been processed and is in its finalization stage.
      FINALIZING = 4;

    • SUCCESSFUL

      public static final OperationState SUCCESSFUL
       Request has completed successfully.
      SUCCESSFUL = 5;

    • FAILED

      public static final OperationState FAILED
       Request has finished being processed, but encountered an error.
      FAILED = 6;

    • CANCELLED

      public static final OperationState CANCELLED
       Request has finished being cancelled after user called
 google.longrunning.Operations.CancelOperation.
      CANCELLED = 7;

    • UNRECOGNIZED

      public static final OperationState UNRECOGNIZED

  • Field Details

    • OPERATION_STATE_UNSPECIFIED_VALUE

      public static final int OPERATION_STATE_UNSPECIFIED_VALUE
       Unspecified.
      OPERATION_STATE_UNSPECIFIED = 0;
      See Also:

    • INITIALIZING_VALUE

      public static final int INITIALIZING_VALUE
       Request is being prepared for processing.
      INITIALIZING = 1;
      See Also:

    • PROCESSING_VALUE

      public static final int PROCESSING_VALUE
       Request is actively being processed.
      PROCESSING = 2;
      See Also:

    • CANCELLING_VALUE

      public static final int CANCELLING_VALUE
       Request is in the process of being cancelled after user called
 google.longrunning.Operations.CancelOperation on the operation.
      CANCELLING = 3;
      See Also:

    • FINALIZING_VALUE

      public static final int FINALIZING_VALUE
       Request has been processed and is in its finalization stage.
      FINALIZING = 4;
      See Also:

    • SUCCESSFUL_VALUE

      public static final int SUCCESSFUL_VALUE
       Request has completed successfully.
      SUCCESSFUL = 5;
      See Also:

    • FAILED_VALUE

      public static final int FAILED_VALUE
       Request has finished being processed, but encountered an error.
      FAILED = 6;
      See Also:

    • CANCELLED_VALUE

      public static final int CANCELLED_VALUE
       Request has finished being cancelled after user called
 google.longrunning.Operations.CancelOperation.
      CANCELLED = 7;
      See Also:

  • Method Details

    • values

      public static OperationState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static OperationState valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static OperationState valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static OperationState forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<OperationState> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static OperationState valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null