Package com.google.cloud.aiplatform.v1

Class StudySpec.MetricSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.StudySpec.MetricSpec
All Implemented Interfaces:
StudySpec.MetricSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
StudySpec
public static final class StudySpec.MetricSpec extends com.google.protobuf.GeneratedMessage implements StudySpec.MetricSpecOrBuilder
 Represents a metric to optimize.
Protobuf type google.cloud.aiplatform.v1.StudySpec.MetricSpec
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getMetricId in interface StudySpec.MetricSpecOrBuilder
      Returns:
      The metricId.

    • getMetricIdBytes

      public com.google.protobuf.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];
      Specified by:
      getMetricIdBytes in interface StudySpec.MetricSpecOrBuilder
      Returns:
      The bytes for metricId.

    • 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];
      Specified by:
      getGoalValue in interface StudySpec.MetricSpecOrBuilder
      Returns:
      The enum numeric value on the wire for goal.

    • 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];
      Specified by:
      getGoal in interface StudySpec.MetricSpecOrBuilder
      Returns:
      The goal.

    • 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;
      Specified by:
      hasSafetyConfig in interface StudySpec.MetricSpecOrBuilder
      Returns:
      Whether the safetyConfig field is set.

    • 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;
      Specified by:
      getSafetyConfig in interface StudySpec.MetricSpecOrBuilder
      Returns:
      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;
      Specified by:
      getSafetyConfigOrBuilder in interface StudySpec.MetricSpecOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static StudySpec.MetricSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.MetricSpec parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.MetricSpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.MetricSpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.MetricSpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.MetricSpec parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.MetricSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StudySpec.MetricSpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StudySpec.MetricSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StudySpec.MetricSpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StudySpec.MetricSpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StudySpec.MetricSpec parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public StudySpec.MetricSpec.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static StudySpec.MetricSpec.Builder newBuilder()

    • newBuilder

      public static StudySpec.MetricSpec.Builder newBuilder(StudySpec.MetricSpec prototype)

    • toBuilder

      public StudySpec.MetricSpec.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected StudySpec.MetricSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static StudySpec.MetricSpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StudySpec.MetricSpec> parser()

    • getParserForType

      public com.google.protobuf.Parser<StudySpec.MetricSpec> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public StudySpec.MetricSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder