com.google.cloud

Enum OperationResponseMapping

java.lang.Object

java.lang.Enum<OperationResponseMapping>

com.google.cloud.OperationResponseMapping

All Implemented Interfaces:

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

public enum OperationResponseMapping
extends Enum<OperationResponseMapping>
implements com.google.protobuf.ProtocolMessageEnum

 An enum to be used to mark the essential (for polling) fields in an
 API-specific Operation object. A custom Operation object may contain many
 different fields, but only few of them are essential to conduct a successful
 polling process.
 

Protobuf enum google.cloud.OperationResponseMapping

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR_CODE A field in an API-specific (custom) Operation object which carries the same meaning as google.longrunning.Operation.error.code.
ERROR_MESSAGE A field in an API-specific (custom) Operation object which carries the same meaning as google.longrunning.Operation.error.message.
NAME A field in an API-specific (custom) Operation object which carries the same meaning as google.longrunning.Operation.name.
STATUS A field in an API-specific (custom) Operation object which carries the same meaning as google.longrunning.Operation.done.
UNDEFINED Do not use.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_CODE_VALUE A field in an API-specific (custom) Operation object which carries the same meaning as google.longrunning.Operation.error.code.
static int	ERROR_MESSAGE_VALUE A field in an API-specific (custom) Operation object which carries the same meaning as google.longrunning.Operation.error.message.
static int	NAME_VALUE A field in an API-specific (custom) Operation object which carries the same meaning as google.longrunning.Operation.name.
static int	STATUS_VALUE A field in an API-specific (custom) Operation object which carries the same meaning as google.longrunning.Operation.done.
static int	UNDEFINED_VALUE Do not use.

Method Summary

Modifier and Type	Method and Description
static OperationResponseMapping	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<OperationResponseMapping>	internalGetValueMap()
static OperationResponseMapping	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static OperationResponseMapping	valueOf(int value) Deprecated. Use forNumber(int) instead.
static OperationResponseMapping	valueOf(String name) Returns the enum constant of this type with the specified name.
static OperationResponseMapping[]	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

UNDEFINED

public static final OperationResponseMapping UNDEFINED

 Do not use.
 

UNDEFINED = 0;

NAME

public static final OperationResponseMapping NAME

 A field in an API-specific (custom) Operation object which carries the same
 meaning as google.longrunning.Operation.name.
 

NAME = 1;

STATUS

public static final OperationResponseMapping STATUS

 A field in an API-specific (custom) Operation object which carries the same
 meaning as google.longrunning.Operation.done. If the annotated field is of
 an enum type, `annotated_field_name == EnumType.DONE` semantics should be
 equivalent to `Operation.done == true`. If the annotated field is of type
 boolean, then it should follow the same semantics as Operation.done.
 Otherwise, a non-empty value should be treated as `Operation.done == true`.
 

STATUS = 2;

ERROR_CODE

public static final OperationResponseMapping ERROR_CODE

 A field in an API-specific (custom) Operation object which carries the same
 meaning as google.longrunning.Operation.error.code.
 

ERROR_CODE = 3;

ERROR_MESSAGE

public static final OperationResponseMapping ERROR_MESSAGE

 A field in an API-specific (custom) Operation object which carries the same
 meaning as google.longrunning.Operation.error.message.
 

ERROR_MESSAGE = 4;

UNRECOGNIZED

public static final OperationResponseMapping UNRECOGNIZED

Field Detail

UNDEFINED_VALUE

public static final int UNDEFINED_VALUE

 Do not use.
 

UNDEFINED = 0;

See Also:

Constant Field Values

NAME_VALUE

public static final int NAME_VALUE

 A field in an API-specific (custom) Operation object which carries the same
 meaning as google.longrunning.Operation.name.
 

NAME = 1;

See Also:

Constant Field Values

STATUS_VALUE

public static final int STATUS_VALUE

 A field in an API-specific (custom) Operation object which carries the same
 meaning as google.longrunning.Operation.done. If the annotated field is of
 an enum type, `annotated_field_name == EnumType.DONE` semantics should be
 equivalent to `Operation.done == true`. If the annotated field is of type
 boolean, then it should follow the same semantics as Operation.done.
 Otherwise, a non-empty value should be treated as `Operation.done == true`.
 

STATUS = 2;

See Also:

Constant Field Values

ERROR_CODE_VALUE

public static final int ERROR_CODE_VALUE

 A field in an API-specific (custom) Operation object which carries the same
 meaning as google.longrunning.Operation.error.code.
 

ERROR_CODE = 3;

See Also:

Constant Field Values

ERROR_MESSAGE_VALUE

public static final int ERROR_MESSAGE_VALUE

 A field in an API-specific (custom) Operation object which carries the same
 meaning as google.longrunning.Operation.error.message.
 

ERROR_MESSAGE = 4;

See Also:

Constant Field Values

Method Detail

values

public static OperationResponseMapping[] 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 (OperationResponseMapping c : OperationResponseMapping.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OperationResponseMapping 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 OperationResponseMapping 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 OperationResponseMapping 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<OperationResponseMapping> 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 OperationResponseMapping valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)