Batch.State (Google Cloud Dataproc Parent 4.0.8 API)

java.lang.Object
- java.lang.Enum<Batch.State>
- - com.google.cloud.dataproc.v1.Batch.State

All Implemented Interfaces:

Internal.EnumLite, ProtocolMessageEnum, Serializable, Comparable<Batch.State>

Enclosing class:

Batch
```
public static enum Batch.State
extends Enum<Batch.State>
implements ProtocolMessageEnum
```
```
 The batch state.
 
```
Protobuf enum google.cloud.dataproc.v1.Batch.State

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CANCELLED` The batch cancellation was successful.
`CANCELLING` The batch is cancelling.
`FAILED` The batch is no longer running due to an error.
`PENDING` The batch is created before running.
`RUNNING` The batch is running.
`STATE_UNSPECIFIED` The batch state is unknown.
`SUCCEEDED` The batch completed successfully.
`UNRECOGNIZED`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CANCELLED_VALUE` The batch cancellation was successful.
`static int`	`CANCELLING_VALUE` The batch is cancelling.
`static int`	`FAILED_VALUE` The batch is no longer running due to an error.
`static int`	`PENDING_VALUE` The batch is created before running.
`static int`	`RUNNING_VALUE` The batch is running.
`static int`	`STATE_UNSPECIFIED_VALUE` The batch state is unknown.
`static int`	`SUCCEEDED_VALUE` The batch completed successfully.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Batch.State`	`forNumber(int value)`
`static Descriptors.EnumDescriptor`	`getDescriptor()`
`Descriptors.EnumDescriptor`	`getDescriptorForType()`
`int`	`getNumber()`
`Descriptors.EnumValueDescriptor`	`getValueDescriptor()`
`static Internal.EnumLiteMap<Batch.State>`	`internalGetValueMap()`
`static Batch.State`	`valueOf(Descriptors.EnumValueDescriptor desc)`
`static Batch.State`	`valueOf(int value)` Deprecated. Use `forNumber(int)` instead.
`static Batch.State`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Batch.State[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - STATE_UNSPECIFIED
```
public static final Batch.State STATE_UNSPECIFIED
```
```
 The batch state is unknown.
 
```
    STATE_UNSPECIFIED = 0;
  - PENDING
```
public static final Batch.State PENDING
```
```
 The batch is created before running.
 
```
    PENDING = 1;
  - RUNNING
```
public static final Batch.State RUNNING
```
```
 The batch is running.
 
```
    RUNNING = 2;
  - CANCELLING
```
public static final Batch.State CANCELLING
```
```
 The batch is cancelling.
 
```
    CANCELLING = 3;
  - CANCELLED
```
public static final Batch.State CANCELLED
```
```
 The batch cancellation was successful.
 
```
    CANCELLED = 4;
  - SUCCEEDED
```
public static final Batch.State SUCCEEDED
```
```
 The batch completed successfully.
 
```
    SUCCEEDED = 5;
  - FAILED
```
public static final Batch.State FAILED
```
```
 The batch is no longer running due to an error.
 
```
    FAILED = 6;
  - UNRECOGNIZED
```
public static final Batch.State UNRECOGNIZED
```
- Field Detail
  - STATE_UNSPECIFIED_VALUE
```
public static final int STATE_UNSPECIFIED_VALUE
```
```
 The batch state is unknown.
 
```
    STATE_UNSPECIFIED = 0;
    See Also:
    
    Constant Field Values
  - PENDING_VALUE
```
public static final int PENDING_VALUE
```
```
 The batch is created before running.
 
```
    PENDING = 1;
    See Also:
    
    Constant Field Values
  - RUNNING_VALUE
```
public static final int RUNNING_VALUE
```
```
 The batch is running.
 
```
    RUNNING = 2;
    See Also:
    
    Constant Field Values
  - CANCELLING_VALUE
```
public static final int CANCELLING_VALUE
```
```
 The batch is cancelling.
 
```
    CANCELLING = 3;
    See Also:
    
    Constant Field Values
  - CANCELLED_VALUE
```
public static final int CANCELLED_VALUE
```
```
 The batch cancellation was successful.
 
```
    CANCELLED = 4;
    See Also:
    
    Constant Field Values
  - SUCCEEDED_VALUE
```
public static final int SUCCEEDED_VALUE
```
```
 The batch completed successfully.
 
```
    SUCCEEDED = 5;
    See Also:
    
    Constant Field Values
  - FAILED_VALUE
```
public static final int FAILED_VALUE
```
```
 The batch is no longer running due to an error.
 
```
    FAILED = 6;
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static Batch.State[] 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 (Batch.State c : Batch.State.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Batch.State 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 Internal.EnumLite
    
    Specified by:
    
    getNumber in interface ProtocolMessageEnum
  - valueOf
```
@Deprecated
public static Batch.State valueOf(int value)
```
    Deprecated. Use forNumber(int) instead.
    
    Parameters:
    
    value - The numeric wire value of the corresponding enum entry.
    
    Returns:
    
    The enum associated with the given numeric wire value.
  - forNumber
```
public static Batch.State 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 Internal.EnumLiteMap<Batch.State> internalGetValueMap()
```
  - getValueDescriptor
```
public final Descriptors.EnumValueDescriptor getValueDescriptor()
```
    Specified by:
    
    getValueDescriptor in interface ProtocolMessageEnum
  - getDescriptorForType
```
public final Descriptors.EnumDescriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface ProtocolMessageEnum
  - getDescriptor
```
public static final Descriptors.EnumDescriptor getDescriptor()
```
  - valueOf
```
public static Batch.State valueOf(Descriptors.EnumValueDescriptor desc)
```

Enum Batch.State

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

STATE_UNSPECIFIED

PENDING

RUNNING

CANCELLING

CANCELLED

SUCCEEDED

FAILED

UNRECOGNIZED

Field Detail

STATE_UNSPECIFIED_VALUE

PENDING_VALUE

RUNNING_VALUE

CANCELLING_VALUE

CANCELLED_VALUE

SUCCEEDED_VALUE

FAILED_VALUE

Method Detail

values

valueOf

getNumber

valueOf

forNumber

internalGetValueMap

getValueDescriptor

getDescriptorForType

getDescriptor

valueOf