Class StudySpec.MetricSpec (3.43.0)

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

Represents a metric to optimize.

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

Static Fields

GOAL_FIELD_NUMBER

public static final int GOAL_FIELD_NUMBER
Field Value
Type Description
int

METRIC_ID_FIELD_NUMBER

public static final int METRIC_ID_FIELD_NUMBER
Field Value
Type Description
int

SAFETY_CONFIG_FIELD_NUMBER

public static final int SAFETY_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StudySpec.MetricSpec getDefaultInstance()
Returns
Type Description
StudySpec.MetricSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static StudySpec.MetricSpec.Builder newBuilder()
Returns
Type Description
StudySpec.MetricSpec.Builder

newBuilder(StudySpec.MetricSpec prototype)

public static StudySpec.MetricSpec.Builder newBuilder(StudySpec.MetricSpec prototype)
Parameter
Name Description
prototype StudySpec.MetricSpec
Returns
Type Description
StudySpec.MetricSpec.Builder

parseDelimitedFrom(InputStream input)

public static StudySpec.MetricSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StudySpec.MetricSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MetricSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.MetricSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StudySpec.MetricSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StudySpec.MetricSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MetricSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.MetricSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StudySpec.MetricSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StudySpec.MetricSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MetricSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.MetricSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StudySpec.MetricSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StudySpec.MetricSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MetricSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.MetricSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StudySpec.MetricSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StudySpec.MetricSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MetricSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.MetricSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StudySpec.MetricSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StudySpec.MetricSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.MetricSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.MetricSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public StudySpec.MetricSpec getDefaultInstanceForType()
Returns
Type Description
StudySpec.MetricSpec

getGoal()

public StudySpec.MetricSpec.GoalType getGoal()

Required. The optimization goal of the metric.

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

Returns
Type Description
StudySpec.MetricSpec.GoalType

The goal.

getGoalValue()

public int getGoalValue()

Required. The optimization goal of the metric.

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

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for metricId.

getParserForType()

public Parser<StudySpec.MetricSpec> getParserForType()
Returns
Type Description
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.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;

Returns
Type Description
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.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;

Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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.v1.StudySpec.MetricSpec.SafetyMetricConfig safety_config = 3;

Returns
Type Description
boolean

Whether the safetyConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StudySpec.MetricSpec.Builder newBuilderForType()
Returns
Type Description
StudySpec.MetricSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StudySpec.MetricSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StudySpec.MetricSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public StudySpec.MetricSpec.Builder toBuilder()
Returns
Type Description
StudySpec.MetricSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException