Class Measurement.Builder (3.42.0)

public static final class Measurement.Builder extends GeneratedMessageV3.Builder<Measurement.Builder> 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.v1beta1.Measurement

Static Methods

getDescriptor()

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

Methods

addAllMetrics(Iterable<? extends Measurement.Metric> values)

public Measurement.Builder addAllMetrics(Iterable<? extends Measurement.Metric> values)

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1beta1.Measurement.Metric>
Returns
Type Description
Measurement.Builder

addMetrics(Measurement.Metric value)

public Measurement.Builder addMetrics(Measurement.Metric value)

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Measurement.Metric
Returns
Type Description
Measurement.Builder

addMetrics(Measurement.Metric.Builder builderForValue)

public Measurement.Builder addMetrics(Measurement.Metric.Builder builderForValue)

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Measurement.Metric.Builder
Returns
Type Description
Measurement.Builder

addMetrics(int index, Measurement.Metric value)

public Measurement.Builder addMetrics(int index, Measurement.Metric value)

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value Measurement.Metric
Returns
Type Description
Measurement.Builder

addMetrics(int index, Measurement.Metric.Builder builderForValue)

public Measurement.Builder addMetrics(int index, Measurement.Metric.Builder builderForValue)

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue Measurement.Metric.Builder
Returns
Type Description
Measurement.Builder

addMetricsBuilder()

public Measurement.Metric.Builder addMetricsBuilder()

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Measurement.Metric.Builder

addMetricsBuilder(int index)

public Measurement.Metric.Builder addMetricsBuilder(int index)

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Measurement.Metric.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Measurement.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Measurement.Builder
Overrides

build()

public Measurement build()
Returns
Type Description
Measurement

buildPartial()

public Measurement buildPartial()
Returns
Type Description
Measurement

clear()

public Measurement.Builder clear()
Returns
Type Description
Measurement.Builder
Overrides

clearElapsedDuration()

public Measurement.Builder clearElapsedDuration()

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
Measurement.Builder

clearField(Descriptors.FieldDescriptor field)

public Measurement.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Measurement.Builder
Overrides

clearMetrics()

public Measurement.Builder clearMetrics()

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Measurement.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Measurement.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Measurement.Builder
Overrides

clearStepCount()

public Measurement.Builder clearStepCount()

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
Measurement.Builder

This builder for chaining.

clone()

public Measurement.Builder clone()
Returns
Type Description
Measurement.Builder
Overrides

getDefaultInstanceForType()

public Measurement getDefaultInstanceForType()
Returns
Type Description
Measurement

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getElapsedDurationBuilder()

public Duration.Builder getElapsedDurationBuilder()

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
Builder

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.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Measurement.Metric

getMetricsBuilder(int index)

public Measurement.Metric.Builder getMetricsBuilder(int index)

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Measurement.Metric.Builder

getMetricsBuilderList()

public List<Measurement.Metric.Builder> getMetricsBuilderList()

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getMetricsCount()

public int getMetricsCount()

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeElapsedDuration(Duration value)

public Measurement.Builder mergeElapsedDuration(Duration value)

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

Parameter
Name Description
value Duration
Returns
Type Description
Measurement.Builder

mergeFrom(Measurement other)

public Measurement.Builder mergeFrom(Measurement other)
Parameter
Name Description
other Measurement
Returns
Type Description
Measurement.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Measurement.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Measurement.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Measurement.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Measurement.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Measurement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Measurement.Builder
Overrides

removeMetrics(int index)

public Measurement.Builder removeMetrics(int index)

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Measurement.Builder

setElapsedDuration(Duration value)

public Measurement.Builder setElapsedDuration(Duration value)

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

Parameter
Name Description
value Duration
Returns
Type Description
Measurement.Builder

setElapsedDuration(Duration.Builder builderForValue)

public Measurement.Builder setElapsedDuration(Duration.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Measurement.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Measurement.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Measurement.Builder
Overrides

setMetrics(int index, Measurement.Metric value)

public Measurement.Builder setMetrics(int index, Measurement.Metric value)

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value Measurement.Metric
Returns
Type Description
Measurement.Builder

setMetrics(int index, Measurement.Metric.Builder builderForValue)

public Measurement.Builder setMetrics(int index, Measurement.Metric.Builder builderForValue)

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1beta1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue Measurement.Metric.Builder
Returns
Type Description
Measurement.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Measurement.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Measurement.Builder
Overrides

setStepCount(long value)

public Measurement.Builder setStepCount(long value)

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

Parameter
Name Description
value long

The stepCount to set.

Returns
Type Description
Measurement.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Measurement.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Measurement.Builder
Overrides