com.google.cloud.vision.v1p4beta1

Enum BatchOperationMetadata.State

java.lang.Object

java.lang.Enum<BatchOperationMetadata.State>

com.google.cloud.vision.v1p4beta1.BatchOperationMetadata.State

All Implemented Interfaces:

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

Enclosing class:

BatchOperationMetadata

public static enum BatchOperationMetadata.State
extends Enum<BatchOperationMetadata.State>
implements ProtocolMessageEnum

 Enumerates the possible states that the batch request can be in.
 

Protobuf enum google.cloud.vision.v1p4beta1.BatchOperationMetadata.State

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELLED The request is done after the longrunning.Operations.CancelOperation has been called by the user.
FAILED The request is done and no item has been successfully processed.
PROCESSING Request is actively being processed.
STATE_UNSPECIFIED Invalid.
SUCCESSFUL The request is done and at least one item has been successfully processed.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANCELLED_VALUE The request is done after the longrunning.Operations.CancelOperation has been called by the user.
static int	FAILED_VALUE The request is done and no item has been successfully processed.
static int	PROCESSING_VALUE Request is actively being processed.
static int	STATE_UNSPECIFIED_VALUE Invalid.
static int	SUCCESSFUL_VALUE The request is done and at least one item has been successfully processed.

Method Summary

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

 Invalid.
 

STATE_UNSPECIFIED = 0;

PROCESSING

public static final BatchOperationMetadata.State PROCESSING

 Request is actively being processed.
 

PROCESSING = 1;

SUCCESSFUL

public static final BatchOperationMetadata.State SUCCESSFUL

 The request is done and at least one item has been successfully
 processed.
 

SUCCESSFUL = 2;

FAILED

public static final BatchOperationMetadata.State FAILED

 The request is done and no item has been successfully processed.
 

FAILED = 3;

CANCELLED

public static final BatchOperationMetadata.State CANCELLED

 The request is done after the longrunning.Operations.CancelOperation has
 been called by the user.  Any records that were processed before the
 cancel command are output as specified in the request.
 

CANCELLED = 4;

UNRECOGNIZED

public static final BatchOperationMetadata.State UNRECOGNIZED

Field Detail

STATE_UNSPECIFIED_VALUE

public static final int STATE_UNSPECIFIED_VALUE

 Invalid.
 

STATE_UNSPECIFIED = 0;

See Also:

Constant Field Values

PROCESSING_VALUE

public static final int PROCESSING_VALUE

 Request is actively being processed.
 

PROCESSING = 1;

See Also:

Constant Field Values

SUCCESSFUL_VALUE

public static final int SUCCESSFUL_VALUE

 The request is done and at least one item has been successfully
 processed.
 

SUCCESSFUL = 2;

See Also:

Constant Field Values

FAILED_VALUE

public static final int FAILED_VALUE

 The request is done and no item has been successfully processed.
 

FAILED = 3;

See Also:

Constant Field Values

CANCELLED_VALUE

public static final int CANCELLED_VALUE

 The request is done after the longrunning.Operations.CancelOperation has
 been called by the user.  Any records that were processed before the
 cancel command are output as specified in the request.
 

CANCELLED = 4;

See Also:

Constant Field Values

Method Detail

values

public static BatchOperationMetadata.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 (BatchOperationMetadata.State c : BatchOperationMetadata.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 BatchOperationMetadata.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 BatchOperationMetadata.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 BatchOperationMetadata.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<BatchOperationMetadata.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 BatchOperationMetadata.State valueOf(Descriptors.EnumValueDescriptor desc)