Enum OperationState

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<OperationState>

    public enum OperationState
    extends Enum<OperationState>
    implements com.google.protobuf.ProtocolMessageEnum
     List of different operation states.
     High level state of the operation. This is used to report the job's
     current state to the user. Once a long running operation is created,
     the current state of the operation can be queried even before the
     operation is finished and the final result is available.
     
    Protobuf enum google.logging.v2.OperationState
    • Enum Constant Detail

      • OPERATION_STATE_UNSPECIFIED

        public static final OperationState OPERATION_STATE_UNSPECIFIED
         Should not be used.
         
        OPERATION_STATE_UNSPECIFIED = 0;
      • OPERATION_STATE_SCHEDULED

        public static final OperationState OPERATION_STATE_SCHEDULED
         The operation is scheduled.
         
        OPERATION_STATE_SCHEDULED = 1;
      • OPERATION_STATE_WAITING_FOR_PERMISSIONS

        public static final OperationState OPERATION_STATE_WAITING_FOR_PERMISSIONS
         Waiting for necessary permissions.
         
        OPERATION_STATE_WAITING_FOR_PERMISSIONS = 2;
      • OPERATION_STATE_RUNNING

        public static final OperationState OPERATION_STATE_RUNNING
         The operation is running.
         
        OPERATION_STATE_RUNNING = 3;
      • OPERATION_STATE_SUCCEEDED

        public static final OperationState OPERATION_STATE_SUCCEEDED
         The operation was completed successfully.
         
        OPERATION_STATE_SUCCEEDED = 4;
      • OPERATION_STATE_FAILED

        public static final OperationState OPERATION_STATE_FAILED
         The operation failed.
         
        OPERATION_STATE_FAILED = 5;
      • OPERATION_STATE_CANCELLED

        public static final OperationState OPERATION_STATE_CANCELLED
         The operation was cancelled by the user.
         
        OPERATION_STATE_CANCELLED = 6;
    • Field Detail

      • OPERATION_STATE_UNSPECIFIED_VALUE

        public static final int OPERATION_STATE_UNSPECIFIED_VALUE
         Should not be used.
         
        OPERATION_STATE_UNSPECIFIED = 0;
        See Also:
        Constant Field Values
      • OPERATION_STATE_SCHEDULED_VALUE

        public static final int OPERATION_STATE_SCHEDULED_VALUE
         The operation is scheduled.
         
        OPERATION_STATE_SCHEDULED = 1;
        See Also:
        Constant Field Values
      • OPERATION_STATE_WAITING_FOR_PERMISSIONS_VALUE

        public static final int OPERATION_STATE_WAITING_FOR_PERMISSIONS_VALUE
         Waiting for necessary permissions.
         
        OPERATION_STATE_WAITING_FOR_PERMISSIONS = 2;
        See Also:
        Constant Field Values
      • OPERATION_STATE_RUNNING_VALUE

        public static final int OPERATION_STATE_RUNNING_VALUE
         The operation is running.
         
        OPERATION_STATE_RUNNING = 3;
        See Also:
        Constant Field Values
      • OPERATION_STATE_SUCCEEDED_VALUE

        public static final int OPERATION_STATE_SUCCEEDED_VALUE
         The operation was completed successfully.
         
        OPERATION_STATE_SUCCEEDED = 4;
        See Also:
        Constant Field Values
      • OPERATION_STATE_FAILED_VALUE

        public static final int OPERATION_STATE_FAILED_VALUE
         The operation failed.
         
        OPERATION_STATE_FAILED = 5;
        See Also:
        Constant Field Values
      • OPERATION_STATE_CANCELLED_VALUE

        public static final int OPERATION_STATE_CANCELLED_VALUE
         The operation was cancelled by the user.
         
        OPERATION_STATE_CANCELLED = 6;
        See Also:
        Constant Field Values
    • Method Detail

      • values

        public static OperationState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (OperationState c : OperationState.values())
            System.out.println(c);
        
        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 final 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