Class MetricMetadata (3.100.0)

public final class MetricMetadata extends GeneratedMessage implements MetricMetadataOrBuilder

Metadata about the metric, used for visualization and organization.

Protobuf type google.cloud.aiplatform.v1beta1.MetricMetadata

Static Fields

OTHER_METADATA_FIELD_NUMBER

public static final int OTHER_METADATA_FIELD_NUMBER
Field Value
Type Description
int

SCORE_RANGE_FIELD_NUMBER

public static final int SCORE_RANGE_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MetricMetadata getDefaultInstance()
Returns
Type Description
MetricMetadata

getDescriptor()

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

newBuilder()

public static MetricMetadata.Builder newBuilder()
Returns
Type Description
MetricMetadata.Builder

newBuilder(MetricMetadata prototype)

public static MetricMetadata.Builder newBuilder(MetricMetadata prototype)
Parameter
Name Description
prototype MetricMetadata
Returns
Type Description
MetricMetadata.Builder

parseDelimitedFrom(InputStream input)

public static MetricMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetricMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MetricMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MetricMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MetricMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MetricMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MetricMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MetricMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MetricMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MetricMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MetricMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetricMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MetricMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MetricMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MetricMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MetricMetadata> parser()
Returns
Type Description
Parser<MetricMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public MetricMetadata getDefaultInstanceForType()
Returns
Type Description
MetricMetadata

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.

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

getParserForType()

public Parser<MetricMetadata> getParserForType()
Returns
Type Description
Parser<MetricMetadata>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MetricMetadata.Builder newBuilderForType()
Returns
Type Description
MetricMetadata.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected MetricMetadata.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MetricMetadata.Builder
Overrides

toBuilder()

public MetricMetadata.Builder toBuilder()
Returns
Type Description
MetricMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException