Class Measurement (3.43.0)

public final class Measurement extends 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

Static Fields

ELAPSED_DURATION_FIELD_NUMBER

public static final int ELAPSED_DURATION_FIELD_NUMBER
Field Value
Type Description
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
Type Description
int

STEP_COUNT_FIELD_NUMBER

public static final int STEP_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Measurement getDefaultInstance()
Returns
Type Description
Measurement

getDescriptor()

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

newBuilder()

public static Measurement.Builder newBuilder()
Returns
Type Description
Measurement.Builder

newBuilder(Measurement prototype)

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

parseDelimitedFrom(InputStream input)

public static Measurement parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Measurement
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Measurement parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Measurement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Measurement parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Measurement
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Measurement parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Measurement
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Measurement parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Measurement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Measurement> parser()
Returns
Type Description
Parser<Measurement>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Measurement getDefaultInstanceForType()
Returns
Type Description
Measurement

getElapsedDuration()

public 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];

Returns
Type Description
Duration

The elapsedDuration.

getElapsedDurationOrBuilder()

public 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];

Returns
Type Description
DurationOrBuilder

getMetrics(int index)

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];

Parameter
Name Description
index int
Returns
Type Description
Measurement.Metric

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];

Returns
Type Description
int

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];

Returns
Type Description
List<Metric>

getMetricsOrBuilder(int index)

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];

Parameter
Name Description
index int
Returns
Type Description
Measurement.MetricOrBuilder

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];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.Measurement.MetricOrBuilder>

getParserForType()

public Parser<Measurement> getParserForType()
Returns
Type Description
Parser<Measurement>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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];

Returns
Type Description
long

The stepCount.

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];

Returns
Type Description
boolean

Whether the elapsedDuration 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 Measurement.Builder newBuilderForType()
Returns
Type Description
Measurement.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Measurement.Builder toBuilder()
Returns
Type Description
Measurement.Builder

writeTo(CodedOutputStream output)

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