Package com.google.cloud.aiplatform.v1

Class GenerateSyntheticDataRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.GenerateSyntheticDataRequest
All Implemented Interfaces:
GenerateSyntheticDataRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class GenerateSyntheticDataRequest extends com.google.protobuf.GeneratedMessage implements GenerateSyntheticDataRequestOrBuilder
 Request message for DataFoundryService.GenerateSyntheticData.
Protobuf type google.cloud.aiplatform.v1.GenerateSyntheticDataRequest
See Also:

  • Field Details

    • TASK_DESCRIPTION_FIELD_NUMBER

      public static final int TASK_DESCRIPTION_FIELD_NUMBER
      See Also:

    • LOCATION_FIELD_NUMBER

      public static final int LOCATION_FIELD_NUMBER
      See Also:

    • COUNT_FIELD_NUMBER

      public static final int COUNT_FIELD_NUMBER
      See Also:

    • OUTPUT_FIELD_SPECS_FIELD_NUMBER

      public static final int OUTPUT_FIELD_SPECS_FIELD_NUMBER
      See Also:

    • EXAMPLES_FIELD_NUMBER

      public static final int EXAMPLES_FIELD_NUMBER
      See Also:

  • 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

    • getStrategyCase

      public GenerateSyntheticDataRequest.StrategyCase getStrategyCase()
      Specified by:
      getStrategyCase in interface GenerateSyntheticDataRequestOrBuilder

    • hasTaskDescription

      public boolean hasTaskDescription()
       Generate data from a high-level task description.
      .google.cloud.aiplatform.v1.TaskDescriptionStrategy task_description = 3;
      Specified by:
      hasTaskDescription in interface GenerateSyntheticDataRequestOrBuilder
      Returns:
      Whether the taskDescription field is set.

    • getTaskDescription

      public TaskDescriptionStrategy getTaskDescription()
       Generate data from a high-level task description.
      .google.cloud.aiplatform.v1.TaskDescriptionStrategy task_description = 3;
      Specified by:
      getTaskDescription in interface GenerateSyntheticDataRequestOrBuilder
      Returns:
      The taskDescription.

    • getTaskDescriptionOrBuilder

      public TaskDescriptionStrategyOrBuilder getTaskDescriptionOrBuilder()
       Generate data from a high-level task description.
      .google.cloud.aiplatform.v1.TaskDescriptionStrategy task_description = 3;
      Specified by:
      getTaskDescriptionOrBuilder in interface GenerateSyntheticDataRequestOrBuilder

    • getLocation

      public String getLocation()
       Required. The resource name of the Location to run the job.
 Format: `projects/{project}/locations/{location}`
      string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getLocation in interface GenerateSyntheticDataRequestOrBuilder
      Returns:
      The location.

    • getLocationBytes

      public com.google.protobuf.ByteString getLocationBytes()
       Required. The resource name of the Location to run the job.
 Format: `projects/{project}/locations/{location}`
      string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getLocationBytes in interface GenerateSyntheticDataRequestOrBuilder
      Returns:
      The bytes for location.

    • getCount

      public int getCount()
       Required. The number of synthetic examples to generate.
 For this stateless API, the count is limited to a small number.
      int32 count = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCount in interface GenerateSyntheticDataRequestOrBuilder
      Returns:
      The count.

    • getOutputFieldSpecsList

      public List<OutputFieldSpec> getOutputFieldSpecsList()
       Required. The schema of the desired output, defined by a list of fields.
      repeated .google.cloud.aiplatform.v1.OutputFieldSpec output_field_specs = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOutputFieldSpecsList in interface GenerateSyntheticDataRequestOrBuilder

    • getOutputFieldSpecsOrBuilderList

      public List<? extends OutputFieldSpecOrBuilder> getOutputFieldSpecsOrBuilderList()
       Required. The schema of the desired output, defined by a list of fields.
      repeated .google.cloud.aiplatform.v1.OutputFieldSpec output_field_specs = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOutputFieldSpecsOrBuilderList in interface GenerateSyntheticDataRequestOrBuilder

    • getOutputFieldSpecsCount

      public int getOutputFieldSpecsCount()
       Required. The schema of the desired output, defined by a list of fields.
      repeated .google.cloud.aiplatform.v1.OutputFieldSpec output_field_specs = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOutputFieldSpecsCount in interface GenerateSyntheticDataRequestOrBuilder

    • getOutputFieldSpecs

      public OutputFieldSpec getOutputFieldSpecs(int index)
       Required. The schema of the desired output, defined by a list of fields.
      repeated .google.cloud.aiplatform.v1.OutputFieldSpec output_field_specs = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOutputFieldSpecs in interface GenerateSyntheticDataRequestOrBuilder

    • getOutputFieldSpecsOrBuilder

      public OutputFieldSpecOrBuilder getOutputFieldSpecsOrBuilder(int index)
       Required. The schema of the desired output, defined by a list of fields.
      repeated .google.cloud.aiplatform.v1.OutputFieldSpec output_field_specs = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOutputFieldSpecsOrBuilder in interface GenerateSyntheticDataRequestOrBuilder

    • getExamplesList

      public List<SyntheticExample> getExamplesList()
       Optional. A list of few-shot examples to guide the model's output style
 and format.
      repeated .google.cloud.aiplatform.v1.SyntheticExample examples = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExamplesList in interface GenerateSyntheticDataRequestOrBuilder

    • getExamplesOrBuilderList

      public List<? extends SyntheticExampleOrBuilder> getExamplesOrBuilderList()
       Optional. A list of few-shot examples to guide the model's output style
 and format.
      repeated .google.cloud.aiplatform.v1.SyntheticExample examples = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExamplesOrBuilderList in interface GenerateSyntheticDataRequestOrBuilder

    • getExamplesCount

      public int getExamplesCount()
       Optional. A list of few-shot examples to guide the model's output style
 and format.
      repeated .google.cloud.aiplatform.v1.SyntheticExample examples = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExamplesCount in interface GenerateSyntheticDataRequestOrBuilder

    • getExamples

      public SyntheticExample getExamples(int index)
       Optional. A list of few-shot examples to guide the model's output style
 and format.
      repeated .google.cloud.aiplatform.v1.SyntheticExample examples = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExamples in interface GenerateSyntheticDataRequestOrBuilder

    • getExamplesOrBuilder

      public SyntheticExampleOrBuilder getExamplesOrBuilder(int index)
       Optional. A list of few-shot examples to guide the model's output style
 and format.
      repeated .google.cloud.aiplatform.v1.SyntheticExample examples = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExamplesOrBuilder in interface GenerateSyntheticDataRequestOrBuilder

    • 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 GenerateSyntheticDataRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static GenerateSyntheticDataRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static GenerateSyntheticDataRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static GenerateSyntheticDataRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static GenerateSyntheticDataRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static GenerateSyntheticDataRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

      public GenerateSyntheticDataRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static GenerateSyntheticDataRequest.Builder newBuilder()

    • newBuilder

      public static GenerateSyntheticDataRequest.Builder newBuilder(GenerateSyntheticDataRequest prototype)

    • toBuilder

      public GenerateSyntheticDataRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected GenerateSyntheticDataRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static GenerateSyntheticDataRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<GenerateSyntheticDataRequest> 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 GenerateSyntheticDataRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder