Package com.google.cloud.documentai.v1beta3

Enum CommonOperationMetadata.State

java.lang.Object

java.lang.Enum<CommonOperationMetadata.State>

com.google.cloud.documentai.v1beta3.CommonOperationMetadata.State

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<CommonOperationMetadata.State>

Enclosing class:

CommonOperationMetadata

public static enum CommonOperationMetadata.State
extends Enum<CommonOperationMetadata.State>
implements com.google.protobuf.ProtocolMessageEnum

 State of the longrunning operation.
 

Protobuf enum google.cloud.documentai.v1beta3.CommonOperationMetadata.State

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	Operation is cancelled.
CANCELLING	Operation is being cancelled.
FAILED	Operation failed.
RUNNING	Operation is still running.
STATE_UNSPECIFIED	Unspecified state.
SUCCEEDED	Operation succeeded.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static int	CANCELLED_VALUE	Operation is cancelled.
static int	CANCELLING_VALUE	Operation is being cancelled.
static int	FAILED_VALUE	Operation failed.
static int	RUNNING_VALUE	Operation is still running.
static int	STATE_UNSPECIFIED_VALUE	Unspecified state.
static int	SUCCEEDED_VALUE	Operation succeeded.

Method Summary

Modifier and Type	Method	Description
static CommonOperationMetadata.State	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<CommonOperationMetadata.State>	internalGetValueMap()
static CommonOperationMetadata.State	valueOf(int value)	Deprecated.
static CommonOperationMetadata.State	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static CommonOperationMetadata.State	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CommonOperationMetadata.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 CommonOperationMetadata.State STATE_UNSPECIFIED

 Unspecified state.
 

STATE_UNSPECIFIED = 0;

RUNNING

public static final CommonOperationMetadata.State RUNNING

 Operation is still running.
 

RUNNING = 1;

CANCELLING

public static final CommonOperationMetadata.State CANCELLING

 Operation is being cancelled.
 

CANCELLING = 2;

SUCCEEDED

public static final CommonOperationMetadata.State SUCCEEDED

 Operation succeeded.
 

SUCCEEDED = 3;

FAILED

public static final CommonOperationMetadata.State FAILED

 Operation failed.
 

FAILED = 4;

CANCELLED

public static final CommonOperationMetadata.State CANCELLED

 Operation is cancelled.
 

CANCELLED = 5;

UNRECOGNIZED

public static final CommonOperationMetadata.State UNRECOGNIZED

Field Detail

STATE_UNSPECIFIED_VALUE

public static final int STATE_UNSPECIFIED_VALUE

 Unspecified state.
 

STATE_UNSPECIFIED = 0;

See Also:

Constant Field Values

RUNNING_VALUE

public static final int RUNNING_VALUE

 Operation is still running.
 

RUNNING = 1;

See Also:

Constant Field Values

CANCELLING_VALUE

public static final int CANCELLING_VALUE

 Operation is being cancelled.
 

CANCELLING = 2;

See Also:

Constant Field Values

SUCCEEDED_VALUE

public static final int SUCCEEDED_VALUE

 Operation succeeded.
 

SUCCEEDED = 3;

See Also:

Constant Field Values

FAILED_VALUE

public static final int FAILED_VALUE

 Operation failed.
 

FAILED = 4;

See Also:

Constant Field Values

CANCELLED_VALUE

public static final int CANCELLED_VALUE

 Operation is cancelled.
 

CANCELLED = 5;

See Also:

Constant Field Values

Method Detail

values

public static CommonOperationMetadata.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 (CommonOperationMetadata.State c : CommonOperationMetadata.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 CommonOperationMetadata.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 com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static CommonOperationMetadata.State 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 CommonOperationMetadata.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 com.google.protobuf.Internal.EnumLiteMap<CommonOperationMetadata.State> 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 CommonOperationMetadata.State 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