Class Measurement.Builder (3.34.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.v1.Measurement

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1.Measurement.Metric>
Returns
TypeDescription
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.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueMeasurement.Metric
Returns
TypeDescription
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.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueMeasurement.Metric.Builder
Returns
TypeDescription
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.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
valueMeasurement.Metric
Returns
TypeDescription
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.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
builderForValueMeasurement.Metric.Builder
Returns
TypeDescription
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.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Measurement.Metric.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Measurement.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Measurement.Builder
Overrides

build()

public Measurement build()
Returns
TypeDescription
Measurement

buildPartial()

public Measurement buildPartial()
Returns
TypeDescription
Measurement

clear()

public Measurement.Builder clear()
Returns
TypeDescription
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
TypeDescription
Measurement.Builder

clearField(Descriptors.FieldDescriptor field)

public Measurement.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Measurement.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Measurement.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
Measurement.Builder

This builder for chaining.

clone()

public Measurement.Builder clone()
Returns
TypeDescription
Measurement.Builder
Overrides

getDefaultInstanceForType()

public Measurement getDefaultInstanceForType()
Returns
TypeDescription
Measurement

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.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
TypeDescription
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
TypeDescription
boolean

Whether the elapsedDuration field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
Measurement.Builder

mergeFrom(Measurement other)

public Measurement.Builder mergeFrom(Measurement other)
Parameter
NameDescription
otherMeasurement
Returns
TypeDescription
Measurement.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Measurement.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Measurement.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Measurement.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Measurement.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Measurement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
Measurement.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Measurement.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
valueMeasurement.Metric
Returns
TypeDescription
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.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
builderForValueMeasurement.Metric.Builder
Returns
TypeDescription
Measurement.Builder

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

public Measurement.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valuelong

The stepCount to set.

Returns
TypeDescription
Measurement.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Measurement.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Measurement.Builder
Overrides