Class PredefinedMetricSpec.Builder (3.86.0)

public static final class PredefinedMetricSpec.Builder extends GeneratedMessage.Builder<PredefinedMetricSpec.Builder> implements PredefinedMetricSpecOrBuilder

The spec for a pre-defined metric.

Protobuf type google.cloud.aiplatform.v1beta1.PredefinedMetricSpec

Static Methods

getDescriptor()

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

Methods

build()

public PredefinedMetricSpec build()
Returns
Type Description
PredefinedMetricSpec

buildPartial()

public PredefinedMetricSpec buildPartial()
Returns
Type Description
PredefinedMetricSpec

clear()

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

clearMetricSpecName()

public PredefinedMetricSpec.Builder clearMetricSpecName()

Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".

string metric_spec_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PredefinedMetricSpec.Builder

This builder for chaining.

clearMetricSpecParameters()

public PredefinedMetricSpec.Builder clearMetricSpecParameters()

Optional. The parameters needed to run the pre-defined metric.

.google.protobuf.Struct metric_spec_parameters = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PredefinedMetricSpec.Builder

getDefaultInstanceForType()

public PredefinedMetricSpec getDefaultInstanceForType()
Returns
Type Description
PredefinedMetricSpec

getDescriptorForType()

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

getMetricSpecName()

public String getMetricSpecName()

Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".

string metric_spec_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The metricSpecName.

getMetricSpecNameBytes()

public ByteString getMetricSpecNameBytes()

Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".

string metric_spec_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for metricSpecName.

getMetricSpecParameters()

public Struct getMetricSpecParameters()

Optional. The parameters needed to run the pre-defined metric.

.google.protobuf.Struct metric_spec_parameters = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The metricSpecParameters.

getMetricSpecParametersBuilder()

public Struct.Builder getMetricSpecParametersBuilder()

Optional. The parameters needed to run the pre-defined metric.

.google.protobuf.Struct metric_spec_parameters = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getMetricSpecParametersOrBuilder()

public StructOrBuilder getMetricSpecParametersOrBuilder()

Optional. The parameters needed to run the pre-defined metric.

.google.protobuf.Struct metric_spec_parameters = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

hasMetricSpecParameters()

public boolean hasMetricSpecParameters()

Optional. The parameters needed to run the pre-defined metric.

.google.protobuf.Struct metric_spec_parameters = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the metricSpecParameters field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PredefinedMetricSpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeMetricSpecParameters(Struct value)

public PredefinedMetricSpec.Builder mergeMetricSpecParameters(Struct value)

Optional. The parameters needed to run the pre-defined metric.

.google.protobuf.Struct metric_spec_parameters = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
PredefinedMetricSpec.Builder

setMetricSpecName(String value)

public PredefinedMetricSpec.Builder setMetricSpecName(String value)

Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".

string metric_spec_name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The metricSpecName to set.

Returns
Type Description
PredefinedMetricSpec.Builder

This builder for chaining.

setMetricSpecNameBytes(ByteString value)

public PredefinedMetricSpec.Builder setMetricSpecNameBytes(ByteString value)

Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".

string metric_spec_name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for metricSpecName to set.

Returns
Type Description
PredefinedMetricSpec.Builder

This builder for chaining.

setMetricSpecParameters(Struct value)

public PredefinedMetricSpec.Builder setMetricSpecParameters(Struct value)

Optional. The parameters needed to run the pre-defined metric.

.google.protobuf.Struct metric_spec_parameters = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
PredefinedMetricSpec.Builder

setMetricSpecParameters(Struct.Builder builderForValue)

public PredefinedMetricSpec.Builder setMetricSpecParameters(Struct.Builder builderForValue)

Optional. The parameters needed to run the pre-defined metric.

.google.protobuf.Struct metric_spec_parameters = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PredefinedMetricSpec.Builder