Class OutputFieldSpec (3.74.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version latestkeyboard_arrow_down
public final class OutputFieldSpec extends GeneratedMessageV3 implements OutputFieldSpecOrBuilder
Defines a specification for a single output field.
Protobuf type google.cloud.aiplatform.v1.OutputFieldSpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int FIELD_NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int FIELD_TYPE_FIELD_NUMBER
Field Value
Type Description
int
public static final int GUIDANCE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static OutputFieldSpec getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static OutputFieldSpec . Builder newBuilder ()
public static OutputFieldSpec . Builder newBuilder ( OutputFieldSpec prototype )
public static OutputFieldSpec parseDelimitedFrom ( InputStream input )
public static OutputFieldSpec parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static OutputFieldSpec parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static OutputFieldSpec parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static OutputFieldSpec parseFrom ( ByteString data )
public static OutputFieldSpec parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static OutputFieldSpec parseFrom ( CodedInputStream input )
public static OutputFieldSpec parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static OutputFieldSpec parseFrom ( InputStream input )
public static OutputFieldSpec parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static OutputFieldSpec parseFrom ( ByteBuffer data )
public static OutputFieldSpec parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<OutputFieldSpec> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public OutputFieldSpec getDefaultInstanceForType ()
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.
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.
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];
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.
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.
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.
public Parser<OutputFieldSpec> getParserForType ()
Overrides
public int getSerializedSize ()
Returns
Type Description
int
Overrides
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public OutputFieldSpec . Builder newBuilderForType ()
protected OutputFieldSpec . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public OutputFieldSpec . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
