Class PredefinedMetricSpec (3.86.0)

public final class PredefinedMetricSpec extends GeneratedMessage implements PredefinedMetricSpecOrBuilder

The spec for a pre-defined metric.

Protobuf type google.cloud.aiplatform.v1beta1.PredefinedMetricSpec

Static Fields

METRIC_SPEC_NAME_FIELD_NUMBER

public static final int METRIC_SPEC_NAME_FIELD_NUMBER
Field Value
Type Description
int

METRIC_SPEC_PARAMETERS_FIELD_NUMBER

public static final int METRIC_SPEC_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PredefinedMetricSpec getDefaultInstance()
Returns
Type Description
PredefinedMetricSpec

getDescriptor()

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

newBuilder()

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

newBuilder(PredefinedMetricSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public PredefinedMetricSpec getDefaultInstanceForType()
Returns
Type Description
PredefinedMetricSpec

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.

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 PredefinedMetricSpec.Builder newBuilderForType()
Returns
Type Description
PredefinedMetricSpec.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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