com.google.cloud.aiplatform.v1beta1

Class PointwiseMetricSpec.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>

com.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec.Builder

All Implemented Interfaces:

PointwiseMetricSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

PointwiseMetricSpec

public static final class PointwiseMetricSpec.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>
implements PointwiseMetricSpecOrBuilder

 Spec for pointwise metric.
 

Protobuf type google.cloud.aiplatform.v1beta1.PointwiseMetricSpec

Method Summary

Modifier and Type	Method and Description
PointwiseMetricSpec.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
PointwiseMetricSpec	build()
PointwiseMetricSpec	buildPartial()
PointwiseMetricSpec.Builder	clear()
PointwiseMetricSpec.Builder	clearCustomOutputFormatConfig() Optional.
PointwiseMetricSpec.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
PointwiseMetricSpec.Builder	clearMetricPromptTemplate() Required.
PointwiseMetricSpec.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
PointwiseMetricSpec.Builder	clearSystemInstruction() Optional.
PointwiseMetricSpec.Builder	clone()
CustomOutputFormatConfig	getCustomOutputFormatConfig() Optional.
CustomOutputFormatConfig.Builder	getCustomOutputFormatConfigBuilder() Optional.
CustomOutputFormatConfigOrBuilder	getCustomOutputFormatConfigOrBuilder() Optional.
PointwiseMetricSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getMetricPromptTemplate() Required.
com.google.protobuf.ByteString	getMetricPromptTemplateBytes() Required.
String	getSystemInstruction() Optional.
com.google.protobuf.ByteString	getSystemInstructionBytes() Optional.
boolean	hasCustomOutputFormatConfig() Optional.
boolean	hasMetricPromptTemplate() Required.
boolean	hasSystemInstruction() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
PointwiseMetricSpec.Builder	mergeCustomOutputFormatConfig(CustomOutputFormatConfig value) Optional.
PointwiseMetricSpec.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
PointwiseMetricSpec.Builder	mergeFrom(com.google.protobuf.Message other)
PointwiseMetricSpec.Builder	mergeFrom(PointwiseMetricSpec other)
PointwiseMetricSpec.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
PointwiseMetricSpec.Builder	setCustomOutputFormatConfig(CustomOutputFormatConfig.Builder builderForValue) Optional.
PointwiseMetricSpec.Builder	setCustomOutputFormatConfig(CustomOutputFormatConfig value) Optional.
PointwiseMetricSpec.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
PointwiseMetricSpec.Builder	setMetricPromptTemplate(String value) Required.
PointwiseMetricSpec.Builder	setMetricPromptTemplateBytes(com.google.protobuf.ByteString value) Required.
PointwiseMetricSpec.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
PointwiseMetricSpec.Builder	setSystemInstruction(String value) Optional.
PointwiseMetricSpec.Builder	setSystemInstructionBytes(com.google.protobuf.ByteString value) Optional.
PointwiseMetricSpec.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>

clear

public PointwiseMetricSpec.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>

getDefaultInstanceForType

public PointwiseMetricSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public PointwiseMetricSpec build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public PointwiseMetricSpec buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public PointwiseMetricSpec.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>

setField

public PointwiseMetricSpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>

clearField

public PointwiseMetricSpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>

clearOneof

public PointwiseMetricSpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>

setRepeatedField

public PointwiseMetricSpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    int index,
                                                    Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>

addRepeatedField

public PointwiseMetricSpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>

mergeFrom

public PointwiseMetricSpec.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PointwiseMetricSpec.Builder>

mergeFrom

public PointwiseMetricSpec.Builder mergeFrom(PointwiseMetricSpec other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>

mergeFrom

public PointwiseMetricSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PointwiseMetricSpec.Builder>

Throws:

IOException

hasMetricPromptTemplate

public boolean hasMetricPromptTemplate()

 Required. Metric prompt template for pointwise metric.
 

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

Specified by:

hasMetricPromptTemplate in interface PointwiseMetricSpecOrBuilder

Returns:

Whether the metricPromptTemplate field is set.

getMetricPromptTemplate

public String getMetricPromptTemplate()

 Required. Metric prompt template for pointwise metric.
 

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

Specified by:

getMetricPromptTemplate in interface PointwiseMetricSpecOrBuilder

Returns:

The metricPromptTemplate.

getMetricPromptTemplateBytes

public com.google.protobuf.ByteString getMetricPromptTemplateBytes()

 Required. Metric prompt template for pointwise metric.
 

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

Specified by:

getMetricPromptTemplateBytes in interface PointwiseMetricSpecOrBuilder

Returns:

The bytes for metricPromptTemplate.

setMetricPromptTemplate

public PointwiseMetricSpec.Builder setMetricPromptTemplate(String value)

 Required. Metric prompt template for pointwise metric.
 

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

Parameters:

value - The metricPromptTemplate to set.

Returns:

This builder for chaining.

clearMetricPromptTemplate

public PointwiseMetricSpec.Builder clearMetricPromptTemplate()

 Required. Metric prompt template for pointwise metric.
 

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

Returns:

This builder for chaining.

setMetricPromptTemplateBytes

public PointwiseMetricSpec.Builder setMetricPromptTemplateBytes(com.google.protobuf.ByteString value)

 Required. Metric prompt template for pointwise metric.
 

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

Parameters:

value - The bytes for metricPromptTemplate to set.

Returns:

This builder for chaining.

hasSystemInstruction

public boolean hasSystemInstruction()

 Optional. System instructions for pointwise metric.
 

optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasSystemInstruction in interface PointwiseMetricSpecOrBuilder

Returns:

Whether the systemInstruction field is set.

getSystemInstruction

public String getSystemInstruction()

 Optional. System instructions for pointwise metric.
 

optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSystemInstruction in interface PointwiseMetricSpecOrBuilder

Returns:

The systemInstruction.

getSystemInstructionBytes

public com.google.protobuf.ByteString getSystemInstructionBytes()

 Optional. System instructions for pointwise metric.
 

optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSystemInstructionBytes in interface PointwiseMetricSpecOrBuilder

Returns:

The bytes for systemInstruction.

setSystemInstruction

public PointwiseMetricSpec.Builder setSystemInstruction(String value)

 Optional. System instructions for pointwise metric.
 

optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The systemInstruction to set.

Returns:

This builder for chaining.

clearSystemInstruction

public PointwiseMetricSpec.Builder clearSystemInstruction()

 Optional. System instructions for pointwise metric.
 

optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setSystemInstructionBytes

public PointwiseMetricSpec.Builder setSystemInstructionBytes(com.google.protobuf.ByteString value)

 Optional. System instructions for pointwise metric.
 

optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The bytes for systemInstruction to set.

Returns:

This builder for chaining.

hasCustomOutputFormatConfig

public boolean hasCustomOutputFormatConfig()

 Optional. CustomOutputFormatConfig allows customization of metric output.
 By default, metrics return a score and explanation.
 When this config is set, the default output is replaced with either:
  - The raw output string.
  - A parsed output based on a user-defined schema.
 If a custom format is chosen, the `score` and `explanation` fields in the
 corresponding metric result will be empty.
 

.google.cloud.aiplatform.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasCustomOutputFormatConfig in interface PointwiseMetricSpecOrBuilder

Returns:

Whether the customOutputFormatConfig field is set.

getCustomOutputFormatConfig

public CustomOutputFormatConfig getCustomOutputFormatConfig()

 Optional. CustomOutputFormatConfig allows customization of metric output.
 By default, metrics return a score and explanation.
 When this config is set, the default output is replaced with either:
  - The raw output string.
  - A parsed output based on a user-defined schema.
 If a custom format is chosen, the `score` and `explanation` fields in the
 corresponding metric result will be empty.
 

.google.cloud.aiplatform.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCustomOutputFormatConfig in interface PointwiseMetricSpecOrBuilder

Returns:

The customOutputFormatConfig.

setCustomOutputFormatConfig

public PointwiseMetricSpec.Builder setCustomOutputFormatConfig(CustomOutputFormatConfig value)

 Optional. CustomOutputFormatConfig allows customization of metric output.
 By default, metrics return a score and explanation.
 When this config is set, the default output is replaced with either:
  - The raw output string.
  - A parsed output based on a user-defined schema.
 If a custom format is chosen, the `score` and `explanation` fields in the
 corresponding metric result will be empty.
 

.google.cloud.aiplatform.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];

setCustomOutputFormatConfig

public PointwiseMetricSpec.Builder setCustomOutputFormatConfig(CustomOutputFormatConfig.Builder builderForValue)

 Optional. CustomOutputFormatConfig allows customization of metric output.
 By default, metrics return a score and explanation.
 When this config is set, the default output is replaced with either:
  - The raw output string.
  - A parsed output based on a user-defined schema.
 If a custom format is chosen, the `score` and `explanation` fields in the
 corresponding metric result will be empty.
 

.google.cloud.aiplatform.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];

mergeCustomOutputFormatConfig

public PointwiseMetricSpec.Builder mergeCustomOutputFormatConfig(CustomOutputFormatConfig value)

 Optional. CustomOutputFormatConfig allows customization of metric output.
 By default, metrics return a score and explanation.
 When this config is set, the default output is replaced with either:
  - The raw output string.
  - A parsed output based on a user-defined schema.
 If a custom format is chosen, the `score` and `explanation` fields in the
 corresponding metric result will be empty.
 

.google.cloud.aiplatform.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];

clearCustomOutputFormatConfig

public PointwiseMetricSpec.Builder clearCustomOutputFormatConfig()

 Optional. CustomOutputFormatConfig allows customization of metric output.
 By default, metrics return a score and explanation.
 When this config is set, the default output is replaced with either:
  - The raw output string.
  - A parsed output based on a user-defined schema.
 If a custom format is chosen, the `score` and `explanation` fields in the
 corresponding metric result will be empty.
 

.google.cloud.aiplatform.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];

getCustomOutputFormatConfigBuilder

public CustomOutputFormatConfig.Builder getCustomOutputFormatConfigBuilder()

 Optional. CustomOutputFormatConfig allows customization of metric output.
 By default, metrics return a score and explanation.
 When this config is set, the default output is replaced with either:
  - The raw output string.
  - A parsed output based on a user-defined schema.
 If a custom format is chosen, the `score` and `explanation` fields in the
 corresponding metric result will be empty.
 

.google.cloud.aiplatform.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];

getCustomOutputFormatConfigOrBuilder

public CustomOutputFormatConfigOrBuilder getCustomOutputFormatConfigOrBuilder()

 Optional. CustomOutputFormatConfig allows customization of metric output.
 By default, metrics return a score and explanation.
 When this config is set, the default output is replaced with either:
  - The raw output string.
  - A parsed output based on a user-defined schema.
 If a custom format is chosen, the `score` and `explanation` fields in the
 corresponding metric result will be empty.
 

.google.cloud.aiplatform.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCustomOutputFormatConfigOrBuilder in interface PointwiseMetricSpecOrBuilder

setUnknownFields

public final PointwiseMetricSpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>

mergeUnknownFields

public final PointwiseMetricSpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder>