Package com.google.cloud.aiplatform.v1

Class Measurement

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Measurement
All Implemented Interfaces:
MeasurementOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Measurement extends com.google.protobuf.GeneratedMessage implements MeasurementOrBuilder
 A message representing a Measurement of a Trial. A Measurement contains
 the Metrics got by executing a Trial using suggested hyperparameter
 values.
Protobuf type google.cloud.aiplatform.v1.Measurement
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Measurement.Builder
    A message representing a Measurement of a Trial.
    static final class 
    Measurement.Metric
    A message representing a metric in the measurement.
    static interface 
    Measurement.MetricOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ELAPSED_DURATION_FIELD_NUMBER
     
    static final int
    METRICS_FIELD_NUMBER
     
    static final int
    STEP_COUNT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Measurement
    getDefaultInstance()
     
    Measurement
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Duration
    getElapsedDuration()
    Output only.
    com.google.protobuf.DurationOrBuilder
    getElapsedDurationOrBuilder()
    Output only.
    Measurement.Metric
    getMetrics(int index)
    Output only.
    int
    getMetricsCount()
    Output only.
    List<Measurement.Metric>
    getMetricsList()
    Output only.
    Measurement.MetricOrBuilder
    getMetricsOrBuilder(int index)
    Output only.
    List<? extends Measurement.MetricOrBuilder>
    getMetricsOrBuilderList()
    Output only.
    com.google.protobuf.Parser<Measurement>
    getParserForType()
     
    int
    getSerializedSize()
     
    long
    getStepCount()
    Output only.
    boolean
    hasElapsedDuration()
    Output only.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Measurement.Builder
    newBuilder()
     
    static Measurement.Builder
    newBuilder(Measurement prototype)
     
    Measurement.Builder
    newBuilderForType()
     
    protected Measurement.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Measurement
    parseDelimitedFrom(InputStream input)
     
    static Measurement
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Measurement
    parseFrom(byte[] data)
     
    static Measurement
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Measurement
    parseFrom(com.google.protobuf.ByteString data)
     
    static Measurement
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Measurement
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Measurement
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Measurement
    parseFrom(InputStream input)
     
    static Measurement
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Measurement
    parseFrom(ByteBuffer data)
     
    static Measurement
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Measurement>
    parser()
     
    Measurement.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • ELAPSED_DURATION_FIELD_NUMBER

      public static final int ELAPSED_DURATION_FIELD_NUMBER
      See Also:

    • STEP_COUNT_FIELD_NUMBER

      public static final int STEP_COUNT_FIELD_NUMBER
      See Also:

    • METRICS_FIELD_NUMBER

      public static final int METRICS_FIELD_NUMBER
      See Also:

  • 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

    • hasElapsedDuration

      public boolean hasElapsedDuration()
       Output only. Time that the Trial has been running at the point of this
 Measurement.
      .google.protobuf.Duration elapsed_duration = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasElapsedDuration in interface MeasurementOrBuilder
      Returns:
      Whether the elapsedDuration field is set.

    • getElapsedDuration

      public com.google.protobuf.Duration getElapsedDuration()
       Output only. Time that the Trial has been running at the point of this
 Measurement.
      .google.protobuf.Duration elapsed_duration = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getElapsedDuration in interface MeasurementOrBuilder
      Returns:
      The elapsedDuration.

    • getElapsedDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getElapsedDurationOrBuilder()
       Output only. Time that the Trial has been running at the point of this
 Measurement.
      .google.protobuf.Duration elapsed_duration = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getElapsedDurationOrBuilder in interface MeasurementOrBuilder

    • getStepCount

      public long getStepCount()
       Output only. The number of steps the machine learning model has been
 trained for. Must be non-negative.
      int64 step_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStepCount in interface MeasurementOrBuilder
      Returns:
      The stepCount.

    • getMetricsList

      public List<Measurement.Metric> getMetricsList()
       Output only. A list of metrics got by evaluating the objective functions
 using suggested Parameter values.
      repeated .google.cloud.aiplatform.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMetricsList in interface MeasurementOrBuilder

    • getMetricsOrBuilderList

      public List<? extends Measurement.MetricOrBuilder> getMetricsOrBuilderList()
       Output only. A list of metrics got by evaluating the objective functions
 using suggested Parameter values.
      repeated .google.cloud.aiplatform.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMetricsOrBuilderList in interface MeasurementOrBuilder

    • getMetricsCount

      public int getMetricsCount()
       Output only. A list of metrics got by evaluating the objective functions
 using suggested Parameter values.
      repeated .google.cloud.aiplatform.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMetricsCount in interface MeasurementOrBuilder

    • getMetrics

      public Measurement.Metric getMetrics(int index)
       Output only. A list of metrics got by evaluating the objective functions
 using suggested Parameter values.
      repeated .google.cloud.aiplatform.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMetrics in interface MeasurementOrBuilder

    • getMetricsOrBuilder

      public Measurement.MetricOrBuilder getMetricsOrBuilder(int index)
       Output only. A list of metrics got by evaluating the objective functions
 using suggested Parameter values.
      repeated .google.cloud.aiplatform.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMetricsOrBuilder in interface MeasurementOrBuilder

    • 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 Measurement parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Measurement parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Measurement parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Measurement.Builder newBuilder()

    • newBuilder

      public static Measurement.Builder newBuilder(Measurement prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Measurement getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Measurement> 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 Measurement getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder