com.google.cloud.aiplatform.v1

Class OutputFieldSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.aiplatform.v1.OutputFieldSpec

All Implemented Interfaces:

OutputFieldSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated
public final class OutputFieldSpec
extends com.google.protobuf.GeneratedMessage
implements OutputFieldSpecOrBuilder

 Defines a specification for a single output field.
 

Protobuf type google.cloud.aiplatform.v1.OutputFieldSpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OutputFieldSpec.Builder Defines a specification for a single output field.
static class	OutputFieldSpec.FieldType The data type of the field.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIELD_NAME_FIELD_NUMBER
static int	FIELD_TYPE_FIELD_NUMBER
static int	GUIDANCE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static OutputFieldSpec	getDefaultInstance()
OutputFieldSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFieldName() Required.
com.google.protobuf.ByteString	getFieldNameBytes() Required.
OutputFieldSpec.FieldType	getFieldType() Optional.
int	getFieldTypeValue() Optional.
String	getGuidance() Optional.
com.google.protobuf.ByteString	getGuidanceBytes() Optional.
com.google.protobuf.Parser<OutputFieldSpec>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static OutputFieldSpec.Builder	newBuilder()
static OutputFieldSpec.Builder	newBuilder(OutputFieldSpec prototype)
OutputFieldSpec.Builder	newBuilderForType()
protected OutputFieldSpec.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static OutputFieldSpec	parseDelimitedFrom(InputStream input)
static OutputFieldSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutputFieldSpec	parseFrom(byte[] data)
static OutputFieldSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutputFieldSpec	parseFrom(ByteBuffer data)
static OutputFieldSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutputFieldSpec	parseFrom(com.google.protobuf.ByteString data)
static OutputFieldSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutputFieldSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static OutputFieldSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutputFieldSpec	parseFrom(InputStream input)
static OutputFieldSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<OutputFieldSpec>	parser()
OutputFieldSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FIELD_NAME_FIELD_NUMBER

public static final int FIELD_NAME_FIELD_NUMBER

See Also:

Constant Field Values

GUIDANCE_FIELD_NUMBER

public static final int GUIDANCE_FIELD_NUMBER

See Also:

Constant Field Values

FIELD_TYPE_FIELD_NUMBER

public static final int FIELD_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getFieldName

public String getFieldName()

 Required. The name of the output field.
 

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

Specified by:

getFieldName in interface OutputFieldSpecOrBuilder

Returns:

The fieldName.

getFieldNameBytes

public com.google.protobuf.ByteString getFieldNameBytes()

 Required. The name of the output field.
 

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

Specified by:

getFieldNameBytes in interface OutputFieldSpecOrBuilder

Returns:

The bytes for fieldName.

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];

Specified by:

getGuidance in interface OutputFieldSpecOrBuilder

Returns:

The guidance.

getGuidanceBytes

public com.google.protobuf.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];

Specified by:

getGuidanceBytes in interface OutputFieldSpecOrBuilder

Returns:

The bytes for guidance.

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];

Specified by:

getFieldTypeValue in interface OutputFieldSpecOrBuilder

Returns:

The enum numeric value on the wire for fieldType.

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];

Specified by:

getFieldType in interface OutputFieldSpecOrBuilder

Returns:

The fieldType.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static OutputFieldSpec parseFrom(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutputFieldSpec parseFrom(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutputFieldSpec parseFrom(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutputFieldSpec parseFrom(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutputFieldSpec parseFrom(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutputFieldSpec parseFrom(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutputFieldSpec parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static OutputFieldSpec parseFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static OutputFieldSpec parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static OutputFieldSpec parseDelimitedFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseFrom

public static OutputFieldSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static OutputFieldSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

newBuilderForType

public OutputFieldSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static OutputFieldSpec.Builder newBuilder()

newBuilder

public static OutputFieldSpec.Builder newBuilder(OutputFieldSpec prototype)

toBuilder

public OutputFieldSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected OutputFieldSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static OutputFieldSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<OutputFieldSpec> parser()

getParserForType

public com.google.protobuf.Parser<OutputFieldSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public OutputFieldSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder