com.google.cloud.vertexai.api

Enum CodeExecutionResult.Outcome

java.lang.Object

java.lang.Enum<CodeExecutionResult.Outcome>

com.google.cloud.vertexai.api.CodeExecutionResult.Outcome

All Implemented Interfaces:

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

Enclosing class:

CodeExecutionResult

public static enum CodeExecutionResult.Outcome
extends Enum<CodeExecutionResult.Outcome>
implements com.google.protobuf.ProtocolMessageEnum

 Enumeration of possible outcomes of the code execution.
 

Protobuf enum google.cloud.vertexai.v1.CodeExecutionResult.Outcome

Enum Constant Summary

Enum Constants

Enum Constant and Description
OUTCOME_DEADLINE_EXCEEDED Code execution ran for too long, and was cancelled.
OUTCOME_FAILED Code execution finished but with a failure.
OUTCOME_OK Code execution completed successfully.
OUTCOME_UNSPECIFIED Unspecified status.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	OUTCOME_DEADLINE_EXCEEDED_VALUE Code execution ran for too long, and was cancelled.
static int	OUTCOME_FAILED_VALUE Code execution finished but with a failure.
static int	OUTCOME_OK_VALUE Code execution completed successfully.
static int	OUTCOME_UNSPECIFIED_VALUE Unspecified status.

Method Summary

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

OUTCOME_UNSPECIFIED

public static final CodeExecutionResult.Outcome OUTCOME_UNSPECIFIED

 Unspecified status. This value should not be used.
 

OUTCOME_UNSPECIFIED = 0;

OUTCOME_OK

public static final CodeExecutionResult.Outcome OUTCOME_OK

 Code execution completed successfully.
 

OUTCOME_OK = 1;

OUTCOME_FAILED

public static final CodeExecutionResult.Outcome OUTCOME_FAILED

 Code execution finished but with a failure. `stderr` should contain the
 reason.
 

OUTCOME_FAILED = 2;

OUTCOME_DEADLINE_EXCEEDED

public static final CodeExecutionResult.Outcome OUTCOME_DEADLINE_EXCEEDED

 Code execution ran for too long, and was cancelled. There may or may not
 be a partial output present.
 

OUTCOME_DEADLINE_EXCEEDED = 3;

UNRECOGNIZED

public static final CodeExecutionResult.Outcome UNRECOGNIZED

Field Detail

OUTCOME_UNSPECIFIED_VALUE

public static final int OUTCOME_UNSPECIFIED_VALUE

 Unspecified status. This value should not be used.
 

OUTCOME_UNSPECIFIED = 0;

See Also:

Constant Field Values

OUTCOME_OK_VALUE

public static final int OUTCOME_OK_VALUE

 Code execution completed successfully.
 

OUTCOME_OK = 1;

See Also:

Constant Field Values

OUTCOME_FAILED_VALUE

public static final int OUTCOME_FAILED_VALUE

 Code execution finished but with a failure. `stderr` should contain the
 reason.
 

OUTCOME_FAILED = 2;

See Also:

Constant Field Values

OUTCOME_DEADLINE_EXCEEDED_VALUE

public static final int OUTCOME_DEADLINE_EXCEEDED_VALUE

 Code execution ran for too long, and was cancelled. There may or may not
 be a partial output present.
 

OUTCOME_DEADLINE_EXCEEDED = 3;

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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