Class OutputFieldSpec.Builder (3.84.0)

public static final class OutputFieldSpec.Builder extends GeneratedMessage.Builder<OutputFieldSpec.Builder> implements OutputFieldSpecOrBuilder

Defines a specification for a single output field.

Protobuf type google.cloud.aiplatform.v1.OutputFieldSpec

Static Methods

getDescriptor()

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

Methods

build()

public OutputFieldSpec build()
Returns
Type Description
OutputFieldSpec

buildPartial()

public OutputFieldSpec buildPartial()
Returns
Type Description
OutputFieldSpec

clear()

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

clearFieldName()

public OutputFieldSpec.Builder clearFieldName()

Required. The name of the output field.

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

Returns
Type Description
OutputFieldSpec.Builder

This builder for chaining.

clearFieldType()

public OutputFieldSpec.Builder clearFieldType()

Optional. The data type of the field. Defaults to CONTENT if not set.

.google.cloud.aiplatform.v1.OutputFieldSpec.FieldType field_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputFieldSpec.Builder

This builder for chaining.

clearGuidance()

public OutputFieldSpec.Builder clearGuidance()

Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.

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

Returns
Type Description
OutputFieldSpec.Builder

This builder for chaining.

getDefaultInstanceForType()

public OutputFieldSpec getDefaultInstanceForType()
Returns
Type Description
OutputFieldSpec

getDescriptorForType()

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

getFieldName()

public String getFieldName()

Required. The name of the output field.

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

Returns
Type Description
String

The fieldName.

getFieldNameBytes()

public ByteString getFieldNameBytes()

Required. The name of the output field.

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

Returns
Type Description
ByteString

The bytes for fieldName.

getFieldType()

public OutputFieldSpec.FieldType getFieldType()

Optional. The data type of the field. Defaults to CONTENT if not set.

.google.cloud.aiplatform.v1.OutputFieldSpec.FieldType field_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputFieldSpec.FieldType

The fieldType.

getFieldTypeValue()

public int getFieldTypeValue()

Optional. The data type of the field. Defaults to CONTENT if not set.

.google.cloud.aiplatform.v1.OutputFieldSpec.FieldType field_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for fieldType.

getGuidance()

public String getGuidance()

Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.

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

Returns
Type Description
String

The guidance.

getGuidanceBytes()

public ByteString getGuidanceBytes()

Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.

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

Returns
Type Description
ByteString

The bytes for guidance.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(OutputFieldSpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFieldName(String value)

public OutputFieldSpec.Builder setFieldName(String value)

Required. The name of the output field.

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

Parameter
Name Description
value String

The fieldName to set.

Returns
Type Description
OutputFieldSpec.Builder

This builder for chaining.

setFieldNameBytes(ByteString value)

public OutputFieldSpec.Builder setFieldNameBytes(ByteString value)

Required. The name of the output field.

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

Parameter
Name Description
value ByteString

The bytes for fieldName to set.

Returns
Type Description
OutputFieldSpec.Builder

This builder for chaining.

setFieldType(OutputFieldSpec.FieldType value)

public OutputFieldSpec.Builder setFieldType(OutputFieldSpec.FieldType value)

Optional. The data type of the field. Defaults to CONTENT if not set.

.google.cloud.aiplatform.v1.OutputFieldSpec.FieldType field_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value OutputFieldSpec.FieldType

The fieldType to set.

Returns
Type Description
OutputFieldSpec.Builder

This builder for chaining.

setFieldTypeValue(int value)

public OutputFieldSpec.Builder setFieldTypeValue(int value)

Optional. The data type of the field. Defaults to CONTENT if not set.

.google.cloud.aiplatform.v1.OutputFieldSpec.FieldType field_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for fieldType to set.

Returns
Type Description
OutputFieldSpec.Builder

This builder for chaining.

setGuidance(String value)

public OutputFieldSpec.Builder setGuidance(String value)

Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.

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

Parameter
Name Description
value String

The guidance to set.

Returns
Type Description
OutputFieldSpec.Builder

This builder for chaining.

setGuidanceBytes(ByteString value)

public OutputFieldSpec.Builder setGuidanceBytes(ByteString value)

Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.

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

Parameter
Name Description
value ByteString

The bytes for guidance to set.

Returns
Type Description
OutputFieldSpec.Builder

This builder for chaining.