Class Metric.Builder (3.59.0)

public static final class Metric.Builder extends GeneratedMessageV3.Builder<Metric.Builder> implements MetricOrBuilder

The metric used for dataset level evaluation.

Protobuf type google.cloud.aiplatform.v1beta1.Metric

Implements

MetricOrBuilder

Static Methods

getDescriptor()

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

Methods

addAggregationMetrics(Metric.AggregationMetric value)

public Metric.Builder addAggregationMetrics(Metric.AggregationMetric value)

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Metric.AggregationMetric

The aggregationMetrics to add.

Returns
Type Description
Metric.Builder

This builder for chaining.

addAggregationMetricsValue(int value)

public Metric.Builder addAggregationMetricsValue(int value)

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for aggregationMetrics to add.

Returns
Type Description
Metric.Builder

This builder for chaining.

addAllAggregationMetrics(Iterable<? extends Metric.AggregationMetric> values)

public Metric.Builder addAllAggregationMetrics(Iterable<? extends Metric.AggregationMetric> values)

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1beta1.Metric.AggregationMetric>

The aggregationMetrics to add.

Returns
Type Description
Metric.Builder

This builder for chaining.

addAllAggregationMetricsValue(Iterable<Integer> values)

public Metric.Builder addAllAggregationMetricsValue(Iterable<Integer> values)

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for aggregationMetrics to add.

Returns
Type Description
Metric.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Metric build()
Returns
Type Description
Metric

buildPartial()

public Metric buildPartial()
Returns
Type Description
Metric

clear()

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

clearAggregationMetrics()

public Metric.Builder clearAggregationMetrics()

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Metric.Builder

This builder for chaining.

clearBleuSpec()

public Metric.Builder clearBleuSpec()

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

Returns
Type Description
Metric.Builder

clearExactMatchSpec()

public Metric.Builder clearExactMatchSpec()

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

Returns
Type Description
Metric.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearMetricSpec()

public Metric.Builder clearMetricSpec()
Returns
Type Description
Metric.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPairwiseMetricSpec()

public Metric.Builder clearPairwiseMetricSpec()

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

Returns
Type Description
Metric.Builder

clearPointwiseMetricSpec()

public Metric.Builder clearPointwiseMetricSpec()

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

Returns
Type Description
Metric.Builder

clearRougeSpec()

public Metric.Builder clearRougeSpec()

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

Returns
Type Description
Metric.Builder

clone()

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

getAggregationMetrics(int index)

public Metric.AggregationMetric getAggregationMetrics(int index)

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
Metric.AggregationMetric

The aggregationMetrics at the given index.

getAggregationMetricsCount()

public int getAggregationMetricsCount()

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of aggregationMetrics.

getAggregationMetricsList()

public List<Metric.AggregationMetric> getAggregationMetricsList()

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<AggregationMetric>

A list containing the aggregationMetrics.

getAggregationMetricsValue(int index)

public int getAggregationMetricsValue(int index)

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of aggregationMetrics at the given index.

getAggregationMetricsValueList()

public List<Integer> getAggregationMetricsValueList()

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for aggregationMetrics.

getBleuSpec()

public BleuSpec getBleuSpec()

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

Returns
Type Description
BleuSpec

The bleuSpec.

getBleuSpecBuilder()

public BleuSpec.Builder getBleuSpecBuilder()

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

Returns
Type Description
BleuSpec.Builder

getBleuSpecOrBuilder()

public BleuSpecOrBuilder getBleuSpecOrBuilder()

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

Returns
Type Description
BleuSpecOrBuilder

getDefaultInstanceForType()

public Metric getDefaultInstanceForType()
Returns
Type Description
Metric

getDescriptorForType()

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

getExactMatchSpec()

public ExactMatchSpec getExactMatchSpec()

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

Returns
Type Description
ExactMatchSpec

The exactMatchSpec.

getExactMatchSpecBuilder()

public ExactMatchSpec.Builder getExactMatchSpecBuilder()

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

Returns
Type Description
ExactMatchSpec.Builder

getExactMatchSpecOrBuilder()

public ExactMatchSpecOrBuilder getExactMatchSpecOrBuilder()

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

Returns
Type Description
ExactMatchSpecOrBuilder

getMetricSpecCase()

public Metric.MetricSpecCase getMetricSpecCase()
Returns
Type Description
Metric.MetricSpecCase

getPairwiseMetricSpec()

public PairwiseMetricSpec getPairwiseMetricSpec()

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

Returns
Type Description
PairwiseMetricSpec

The pairwiseMetricSpec.

getPairwiseMetricSpecBuilder()

public PairwiseMetricSpec.Builder getPairwiseMetricSpecBuilder()

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

Returns
Type Description
PairwiseMetricSpec.Builder

getPairwiseMetricSpecOrBuilder()

public PairwiseMetricSpecOrBuilder getPairwiseMetricSpecOrBuilder()

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

Returns
Type Description
PairwiseMetricSpecOrBuilder

getPointwiseMetricSpec()

public PointwiseMetricSpec getPointwiseMetricSpec()

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

Returns
Type Description
PointwiseMetricSpec

The pointwiseMetricSpec.

getPointwiseMetricSpecBuilder()

public PointwiseMetricSpec.Builder getPointwiseMetricSpecBuilder()

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

Returns
Type Description
PointwiseMetricSpec.Builder

getPointwiseMetricSpecOrBuilder()

public PointwiseMetricSpecOrBuilder getPointwiseMetricSpecOrBuilder()

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

Returns
Type Description
PointwiseMetricSpecOrBuilder

getRougeSpec()

public RougeSpec getRougeSpec()

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

Returns
Type Description
RougeSpec

The rougeSpec.

getRougeSpecBuilder()

public RougeSpec.Builder getRougeSpecBuilder()

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

Returns
Type Description
RougeSpec.Builder

getRougeSpecOrBuilder()

public RougeSpecOrBuilder getRougeSpecOrBuilder()

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

Returns
Type Description
RougeSpecOrBuilder

hasBleuSpec()

public boolean hasBleuSpec()

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

Returns
Type Description
boolean

Whether the bleuSpec field is set.

hasExactMatchSpec()

public boolean hasExactMatchSpec()

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

Returns
Type Description
boolean

Whether the exactMatchSpec field is set.

hasPairwiseMetricSpec()

public boolean hasPairwiseMetricSpec()

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

Returns
Type Description
boolean

Whether the pairwiseMetricSpec field is set.

hasPointwiseMetricSpec()

public boolean hasPointwiseMetricSpec()

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

Returns
Type Description
boolean

Whether the pointwiseMetricSpec field is set.

hasRougeSpec()

public boolean hasRougeSpec()

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

Returns
Type Description
boolean

Whether the rougeSpec field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBleuSpec(BleuSpec value)

public Metric.Builder mergeBleuSpec(BleuSpec value)

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

Parameter
Name Description
value BleuSpec
Returns
Type Description
Metric.Builder

mergeExactMatchSpec(ExactMatchSpec value)

public Metric.Builder mergeExactMatchSpec(ExactMatchSpec value)

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

Parameter
Name Description
value ExactMatchSpec
Returns
Type Description
Metric.Builder

mergeFrom(Metric other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergePairwiseMetricSpec(PairwiseMetricSpec value)

public Metric.Builder mergePairwiseMetricSpec(PairwiseMetricSpec value)

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

Parameter
Name Description
value PairwiseMetricSpec
Returns
Type Description
Metric.Builder

mergePointwiseMetricSpec(PointwiseMetricSpec value)

public Metric.Builder mergePointwiseMetricSpec(PointwiseMetricSpec value)

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

Parameter
Name Description
value PointwiseMetricSpec
Returns
Type Description
Metric.Builder

mergeRougeSpec(RougeSpec value)

public Metric.Builder mergeRougeSpec(RougeSpec value)

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

Parameter
Name Description
value RougeSpec
Returns
Type Description
Metric.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAggregationMetrics(int index, Metric.AggregationMetric value)

public Metric.Builder setAggregationMetrics(int index, Metric.AggregationMetric value)

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value Metric.AggregationMetric

The aggregationMetrics to set.

Returns
Type Description
Metric.Builder

This builder for chaining.

setAggregationMetricsValue(int index, int value)

public Metric.Builder setAggregationMetricsValue(int index, int value)

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for aggregationMetrics to set.

Returns
Type Description
Metric.Builder

This builder for chaining.

setBleuSpec(BleuSpec value)

public Metric.Builder setBleuSpec(BleuSpec value)

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

Parameter
Name Description
value BleuSpec
Returns
Type Description
Metric.Builder

setBleuSpec(BleuSpec.Builder builderForValue)

public Metric.Builder setBleuSpec(BleuSpec.Builder builderForValue)

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

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

setExactMatchSpec(ExactMatchSpec value)

public Metric.Builder setExactMatchSpec(ExactMatchSpec value)

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

Parameter
Name Description
value ExactMatchSpec
Returns
Type Description
Metric.Builder

setExactMatchSpec(ExactMatchSpec.Builder builderForValue)

public Metric.Builder setExactMatchSpec(ExactMatchSpec.Builder builderForValue)

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPairwiseMetricSpec(PairwiseMetricSpec value)

public Metric.Builder setPairwiseMetricSpec(PairwiseMetricSpec value)

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

Parameter
Name Description
value PairwiseMetricSpec
Returns
Type Description
Metric.Builder

setPairwiseMetricSpec(PairwiseMetricSpec.Builder builderForValue)

public Metric.Builder setPairwiseMetricSpec(PairwiseMetricSpec.Builder builderForValue)

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

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

setPointwiseMetricSpec(PointwiseMetricSpec value)

public Metric.Builder setPointwiseMetricSpec(PointwiseMetricSpec value)

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

Parameter
Name Description
value PointwiseMetricSpec
Returns
Type Description
Metric.Builder

setPointwiseMetricSpec(PointwiseMetricSpec.Builder builderForValue)

public Metric.Builder setPointwiseMetricSpec(PointwiseMetricSpec.Builder builderForValue)

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

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

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

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

setRougeSpec(RougeSpec value)

public Metric.Builder setRougeSpec(RougeSpec value)

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

Parameter
Name Description
value RougeSpec
Returns
Type Description
Metric.Builder

setRougeSpec(RougeSpec.Builder builderForValue)

public Metric.Builder setRougeSpec(RougeSpec.Builder builderForValue)

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

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

setUnknownFields(UnknownFieldSet unknownFields)

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