Class StudySpec.MetricSpec (3.20.0)

public static final class StudySpec.MetricSpec extends GeneratedMessageV3 implements StudySpec.MetricSpecOrBuilder

Represents a metric to optimize.

Protobuf type google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec

Static Fields

GOAL_FIELD_NUMBER

public static final int GOAL_FIELD_NUMBER
Field Value
TypeDescription
int

METRIC_ID_FIELD_NUMBER

public static final int METRIC_ID_FIELD_NUMBER
Field Value
TypeDescription
int

SAFETY_CONFIG_FIELD_NUMBER

public static final int SAFETY_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StudySpec.MetricSpec getDefaultInstance()
Returns
TypeDescription
StudySpec.MetricSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static StudySpec.MetricSpec.Builder newBuilder()
Returns
TypeDescription
StudySpec.MetricSpec.Builder

newBuilder(StudySpec.MetricSpec prototype)

public static StudySpec.MetricSpec.Builder newBuilder(StudySpec.MetricSpec prototype)
Parameter
NameDescription
prototypeStudySpec.MetricSpec
Returns
TypeDescription
StudySpec.MetricSpec.Builder

parseDelimitedFrom(InputStream input)

public static StudySpec.MetricSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StudySpec.MetricSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MetricSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.MetricSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static StudySpec.MetricSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
StudySpec.MetricSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MetricSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.MetricSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StudySpec.MetricSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
StudySpec.MetricSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MetricSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.MetricSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StudySpec.MetricSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
StudySpec.MetricSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MetricSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.MetricSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static StudySpec.MetricSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StudySpec.MetricSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MetricSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.MetricSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static StudySpec.MetricSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
StudySpec.MetricSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MetricSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.MetricSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<StudySpec.MetricSpec> parser()
Returns
TypeDescription
Parser<MetricSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public StudySpec.MetricSpec getDefaultInstanceForType()
Returns
TypeDescription
StudySpec.MetricSpec

getGoal()

public StudySpec.MetricSpec.GoalType getGoal()

Required. The optimization goal of the metric.

.google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
StudySpec.MetricSpec.GoalType

The goal.

getGoalValue()

public int getGoalValue()

Required. The optimization goal of the metric.

.google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec.GoalType goal = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for goal.

getMetricId()

public String getMetricId()

Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.

string metric_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The metricId.

getMetricIdBytes()

public ByteString getMetricIdBytes()

Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.

string metric_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for metricId.

getParserForType()

public Parser<StudySpec.MetricSpec> getParserForType()
Returns
TypeDescription
Parser<MetricSpec>
Overrides

getSafetyConfig()

public StudySpec.MetricSpec.SafetyMetricConfig getSafetyConfig()

Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.

optional .google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;

Returns
TypeDescription
StudySpec.MetricSpec.SafetyMetricConfig

The safetyConfig.

getSafetyConfigOrBuilder()

public StudySpec.MetricSpec.SafetyMetricConfigOrBuilder getSafetyConfigOrBuilder()

Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.

optional .google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;

Returns
TypeDescription
StudySpec.MetricSpec.SafetyMetricConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasSafetyConfig()

public boolean hasSafetyConfig()

Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.

optional .google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;

Returns
TypeDescription
boolean

Whether the safetyConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public StudySpec.MetricSpec.Builder newBuilderForType()
Returns
TypeDescription
StudySpec.MetricSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StudySpec.MetricSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
StudySpec.MetricSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public StudySpec.MetricSpec.Builder toBuilder()
Returns
TypeDescription
StudySpec.MetricSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException