Package com.google.cloud.aiplatform.v1

Class Measurement

  • All Implemented Interfaces:
    MeasurementOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Measurement
extends com.google.protobuf.GeneratedMessageV3
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:
    Serialized Form

    • Nested Class Summary

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

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

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

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Field Detail

      • ELAPSED_DURATION_FIELD_NUMBER

        public static final int ELAPSED_DURATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STEP_COUNT_FIELD_NUMBER

        public static final int STEP_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • 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.GeneratedMessageV3

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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​(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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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