Class MetricMetadata.Builder (3.100.0)

public static final class MetricMetadata.Builder extends GeneratedMessage.Builder<MetricMetadata.Builder> implements MetricMetadataOrBuilder

Metadata about the metric, used for visualization and organization.

Protobuf type google.cloud.aiplatform.v1beta1.MetricMetadata

Static Methods

getDescriptor()

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

Methods

build()

public MetricMetadata build()
Returns
Type Description
MetricMetadata

buildPartial()

public MetricMetadata buildPartial()
Returns
Type Description
MetricMetadata

clear()

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

clearOtherMetadata()

public MetricMetadata.Builder clearOtherMetadata()

Optional. Flexible metadata for user-defined attributes.

.google.protobuf.Struct other_metadata = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricMetadata.Builder

clearScoreRange()

public MetricMetadata.Builder clearScoreRange()

Optional. The range of possible scores for this metric, used for plotting.

.google.cloud.aiplatform.v1beta1.MetricMetadata.ScoreRange score_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricMetadata.Builder

clearTitle()

public MetricMetadata.Builder clearTitle()

Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.

string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

getDefaultInstanceForType()

public MetricMetadata getDefaultInstanceForType()
Returns
Type Description
MetricMetadata

getDescriptorForType()

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

getOtherMetadata()

public Struct getOtherMetadata()

Optional. Flexible metadata for user-defined attributes.

.google.protobuf.Struct other_metadata = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The otherMetadata.

getOtherMetadataBuilder()

public Struct.Builder getOtherMetadataBuilder()

Optional. Flexible metadata for user-defined attributes.

.google.protobuf.Struct other_metadata = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getOtherMetadataOrBuilder()

public StructOrBuilder getOtherMetadataOrBuilder()

Optional. Flexible metadata for user-defined attributes.

.google.protobuf.Struct other_metadata = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getScoreRange()

public MetricMetadata.ScoreRange getScoreRange()

Optional. The range of possible scores for this metric, used for plotting.

.google.cloud.aiplatform.v1beta1.MetricMetadata.ScoreRange score_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricMetadata.ScoreRange

The scoreRange.

getScoreRangeBuilder()

public MetricMetadata.ScoreRange.Builder getScoreRangeBuilder()

Optional. The range of possible scores for this metric, used for plotting.

.google.cloud.aiplatform.v1beta1.MetricMetadata.ScoreRange score_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricMetadata.ScoreRange.Builder

getScoreRangeOrBuilder()

public MetricMetadata.ScoreRangeOrBuilder getScoreRangeOrBuilder()

Optional. The range of possible scores for this metric, used for plotting.

.google.cloud.aiplatform.v1beta1.MetricMetadata.ScoreRange score_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricMetadata.ScoreRangeOrBuilder

getTitle()

public String getTitle()

Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.

string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.

string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for title.

hasOtherMetadata()

public boolean hasOtherMetadata()

Optional. Flexible metadata for user-defined attributes.

.google.protobuf.Struct other_metadata = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the otherMetadata field is set.

hasScoreRange()

public boolean hasScoreRange()

Optional. The range of possible scores for this metric, used for plotting.

.google.cloud.aiplatform.v1beta1.MetricMetadata.ScoreRange score_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the scoreRange field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(MetricMetadata other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeOtherMetadata(Struct value)

public MetricMetadata.Builder mergeOtherMetadata(Struct value)

Optional. Flexible metadata for user-defined attributes.

.google.protobuf.Struct other_metadata = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
MetricMetadata.Builder

mergeScoreRange(MetricMetadata.ScoreRange value)

public MetricMetadata.Builder mergeScoreRange(MetricMetadata.ScoreRange value)

Optional. The range of possible scores for this metric, used for plotting.

.google.cloud.aiplatform.v1beta1.MetricMetadata.ScoreRange score_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MetricMetadata.ScoreRange
Returns
Type Description
MetricMetadata.Builder

setOtherMetadata(Struct value)

public MetricMetadata.Builder setOtherMetadata(Struct value)

Optional. Flexible metadata for user-defined attributes.

.google.protobuf.Struct other_metadata = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
MetricMetadata.Builder

setOtherMetadata(Struct.Builder builderForValue)

public MetricMetadata.Builder setOtherMetadata(Struct.Builder builderForValue)

Optional. Flexible metadata for user-defined attributes.

.google.protobuf.Struct other_metadata = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
MetricMetadata.Builder

setScoreRange(MetricMetadata.ScoreRange value)

public MetricMetadata.Builder setScoreRange(MetricMetadata.ScoreRange value)

Optional. The range of possible scores for this metric, used for plotting.

.google.cloud.aiplatform.v1beta1.MetricMetadata.ScoreRange score_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MetricMetadata.ScoreRange
Returns
Type Description
MetricMetadata.Builder

setScoreRange(MetricMetadata.ScoreRange.Builder builderForValue)

public MetricMetadata.Builder setScoreRange(MetricMetadata.ScoreRange.Builder builderForValue)

Optional. The range of possible scores for this metric, used for plotting.

.google.cloud.aiplatform.v1beta1.MetricMetadata.ScoreRange score_range = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue MetricMetadata.ScoreRange.Builder
Returns
Type Description
MetricMetadata.Builder

setTitle(String value)

public MetricMetadata.Builder setTitle(String value)

Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.

string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The title to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.

setTitleBytes(ByteString value)

public MetricMetadata.Builder setTitleBytes(ByteString value)

Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.

string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for title to set.

Returns
Type Description
MetricMetadata.Builder

This builder for chaining.