Package com.google.cloud.aiplatform.v1

Class OutputFieldSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<OutputFieldSpec.Builder>
com.google.cloud.aiplatform.v1.OutputFieldSpec.Builder
All Implemented Interfaces:
OutputFieldSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
OutputFieldSpec
public static final class OutputFieldSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<OutputFieldSpec.Builder> implements OutputFieldSpecOrBuilder
 Defines a specification for a single output field.
Protobuf type google.cloud.aiplatform.v1.OutputFieldSpec

  • Method Details

    • 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.Builder<OutputFieldSpec.Builder>

    • clear

      public OutputFieldSpec.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.GeneratedMessage.Builder<OutputFieldSpec.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.GeneratedMessage.Builder<OutputFieldSpec.Builder>

    • getDefaultInstanceForType

      public OutputFieldSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public OutputFieldSpec build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public OutputFieldSpec buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public OutputFieldSpec.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<OutputFieldSpec.Builder>

    • mergeFrom

      public OutputFieldSpec.Builder mergeFrom(OutputFieldSpec other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<OutputFieldSpec.Builder>

    • mergeFrom

      public OutputFieldSpec.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<OutputFieldSpec.Builder>
      Throws:
      IOException

    • 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.

    • setFieldName

      public OutputFieldSpec.Builder setFieldName(String value)
       Required. The name of the output field.
      string field_name = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The fieldName to set.
      Returns:
      This builder for chaining.

    • clearFieldName

      public OutputFieldSpec.Builder clearFieldName()
       Required. The name of the output field.
      string field_name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setFieldNameBytes

      public OutputFieldSpec.Builder setFieldNameBytes(com.google.protobuf.ByteString value)
       Required. The name of the output field.
      string field_name = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for fieldName to set.
      Returns:
      This builder for chaining.

    • 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.

    • setGuidance

      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];
      Parameters:
      value - The guidance to set.
      Returns:
      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:
      This builder for chaining.

    • setGuidanceBytes

      public OutputFieldSpec.Builder setGuidanceBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for guidance to set.
      Returns:
      This builder for chaining.

    • 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.

    • setFieldTypeValue

      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];
      Parameters:
      value - The enum numeric value on the wire for fieldType to set.
      Returns:
      This builder for chaining.

    • 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.

    • setFieldType

      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];
      Parameters:
      value - The fieldType to set.
      Returns:
      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:
      This builder for chaining.