com.google.cloud.aiplatform.v1beta1

Enum StudySpec.MetricSpec.GoalType

java.lang.Object

java.lang.Enum<StudySpec.MetricSpec.GoalType>

com.google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec.GoalType

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<StudySpec.MetricSpec.GoalType>

Enclosing class:

StudySpec.MetricSpec

public static enum StudySpec.MetricSpec.GoalType
extends Enum<StudySpec.MetricSpec.GoalType>
implements com.google.protobuf.ProtocolMessageEnum

 The available types of optimization goals.
 

Protobuf enum google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec.GoalType

Enum Constant Summary

Enum Constants

Enum Constant and Description
GOAL_TYPE_UNSPECIFIED Goal Type will default to maximize.
MAXIMIZE Maximize the goal metric.
MINIMIZE Minimize the goal metric.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	GOAL_TYPE_UNSPECIFIED_VALUE Goal Type will default to maximize.
static int	MAXIMIZE_VALUE Maximize the goal metric.
static int	MINIMIZE_VALUE Minimize the goal metric.

Method Summary

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

GOAL_TYPE_UNSPECIFIED

public static final StudySpec.MetricSpec.GoalType GOAL_TYPE_UNSPECIFIED

 Goal Type will default to maximize.
 

GOAL_TYPE_UNSPECIFIED = 0;

MAXIMIZE

public static final StudySpec.MetricSpec.GoalType MAXIMIZE

 Maximize the goal metric.
 

MAXIMIZE = 1;

MINIMIZE

public static final StudySpec.MetricSpec.GoalType MINIMIZE

 Minimize the goal metric.
 

MINIMIZE = 2;

UNRECOGNIZED

public static final StudySpec.MetricSpec.GoalType UNRECOGNIZED

Field Detail

GOAL_TYPE_UNSPECIFIED_VALUE

public static final int GOAL_TYPE_UNSPECIFIED_VALUE

 Goal Type will default to maximize.
 

GOAL_TYPE_UNSPECIFIED = 0;

See Also:

Constant Field Values

MAXIMIZE_VALUE

public static final int MAXIMIZE_VALUE

 Maximize the goal metric.
 

MAXIMIZE = 1;

See Also:

Constant Field Values

MINIMIZE_VALUE

public static final int MINIMIZE_VALUE

 Minimize the goal metric.
 

MINIMIZE = 2;

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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