Package com.google.cloud.aiplatform.v1

Class GenerateSyntheticDataRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<GenerateSyntheticDataRequest.Builder>
com.google.cloud.aiplatform.v1.GenerateSyntheticDataRequest.Builder
All Implemented Interfaces:
GenerateSyntheticDataRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
GenerateSyntheticDataRequest
public static final class GenerateSyntheticDataRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<GenerateSyntheticDataRequest.Builder> implements GenerateSyntheticDataRequestOrBuilder
 Request message for DataFoundryService.GenerateSyntheticData.
Protobuf type google.cloud.aiplatform.v1.GenerateSyntheticDataRequest

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public GenerateSyntheticDataRequest.Builder mergeFrom(GenerateSyntheticDataRequest other)

    • isInitialized

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

    • mergeFrom

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

    • getStrategyCase

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

    • clearStrategy

      public GenerateSyntheticDataRequest.Builder clearStrategy()

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

    • setTaskDescription

      public GenerateSyntheticDataRequest.Builder setTaskDescription(TaskDescriptionStrategy value)
       Generate data from a high-level task description.
      .google.cloud.aiplatform.v1.TaskDescriptionStrategy task_description = 3;

    • setTaskDescription

      public GenerateSyntheticDataRequest.Builder setTaskDescription(TaskDescriptionStrategy.Builder builderForValue)
       Generate data from a high-level task description.
      .google.cloud.aiplatform.v1.TaskDescriptionStrategy task_description = 3;

    • mergeTaskDescription

      public GenerateSyntheticDataRequest.Builder mergeTaskDescription(TaskDescriptionStrategy value)
       Generate data from a high-level task description.
      .google.cloud.aiplatform.v1.TaskDescriptionStrategy task_description = 3;

    • clearTaskDescription

      public GenerateSyntheticDataRequest.Builder clearTaskDescription()
       Generate data from a high-level task description.
      .google.cloud.aiplatform.v1.TaskDescriptionStrategy task_description = 3;

    • getTaskDescriptionBuilder

      public TaskDescriptionStrategy.Builder getTaskDescriptionBuilder()
       Generate data from a high-level task description.
      .google.cloud.aiplatform.v1.TaskDescriptionStrategy task_description = 3;

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

    • setLocation

      public GenerateSyntheticDataRequest.Builder setLocation(String value)
       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) = { ... }
      Parameters:
      value - The location to set.
      Returns:
      This builder for chaining.

    • clearLocation

      public GenerateSyntheticDataRequest.Builder clearLocation()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setLocationBytes

      public GenerateSyntheticDataRequest.Builder setLocationBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for location to set.
      Returns:
      This builder for chaining.

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

    • setCount

      public GenerateSyntheticDataRequest.Builder setCount(int value)
       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];
      Parameters:
      value - The count to set.
      Returns:
      This builder for chaining.

    • clearCount

      public GenerateSyntheticDataRequest.Builder clearCount()
       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];
      Returns:
      This builder for chaining.

    • 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

    • 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

    • setOutputFieldSpecs

      public GenerateSyntheticDataRequest.Builder setOutputFieldSpecs(int index, OutputFieldSpec value)
       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];

    • setOutputFieldSpecs

      public GenerateSyntheticDataRequest.Builder setOutputFieldSpecs(int index, OutputFieldSpec.Builder builderForValue)
       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];

    • addOutputFieldSpecs

      public GenerateSyntheticDataRequest.Builder addOutputFieldSpecs(OutputFieldSpec value)
       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];

    • addOutputFieldSpecs

      public GenerateSyntheticDataRequest.Builder addOutputFieldSpecs(int index, OutputFieldSpec value)
       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];

    • addOutputFieldSpecs

      public GenerateSyntheticDataRequest.Builder addOutputFieldSpecs(OutputFieldSpec.Builder builderForValue)
       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];

    • addOutputFieldSpecs

      public GenerateSyntheticDataRequest.Builder addOutputFieldSpecs(int index, OutputFieldSpec.Builder builderForValue)
       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];

    • addAllOutputFieldSpecs

      public GenerateSyntheticDataRequest.Builder addAllOutputFieldSpecs(Iterable<? extends OutputFieldSpec> values)
       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];

    • clearOutputFieldSpecs

      public GenerateSyntheticDataRequest.Builder clearOutputFieldSpecs()
       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];

    • removeOutputFieldSpecs

      public GenerateSyntheticDataRequest.Builder removeOutputFieldSpecs(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];

    • getOutputFieldSpecsBuilder

      public OutputFieldSpec.Builder getOutputFieldSpecsBuilder(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];

    • 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

    • 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

    • addOutputFieldSpecsBuilder

      public OutputFieldSpec.Builder addOutputFieldSpecsBuilder()
       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];

    • addOutputFieldSpecsBuilder

      public OutputFieldSpec.Builder addOutputFieldSpecsBuilder(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];

    • getOutputFieldSpecsBuilderList

      public List<OutputFieldSpec.Builder> getOutputFieldSpecsBuilderList()
       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];

    • 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

    • 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

    • setExamples

      public GenerateSyntheticDataRequest.Builder setExamples(int index, SyntheticExample value)
       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];

    • setExamples

      public GenerateSyntheticDataRequest.Builder setExamples(int index, SyntheticExample.Builder builderForValue)
       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];

    • addExamples

      public GenerateSyntheticDataRequest.Builder addExamples(SyntheticExample value)
       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];

    • addExamples

      public GenerateSyntheticDataRequest.Builder addExamples(int index, SyntheticExample value)
       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];

    • addExamples

      public GenerateSyntheticDataRequest.Builder addExamples(SyntheticExample.Builder builderForValue)
       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];

    • addExamples

      public GenerateSyntheticDataRequest.Builder addExamples(int index, SyntheticExample.Builder builderForValue)
       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];

    • addAllExamples

      public GenerateSyntheticDataRequest.Builder addAllExamples(Iterable<? extends SyntheticExample> values)
       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];

    • clearExamples

      public GenerateSyntheticDataRequest.Builder clearExamples()
       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];

    • removeExamples

      public GenerateSyntheticDataRequest.Builder removeExamples(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];

    • getExamplesBuilder

      public SyntheticExample.Builder getExamplesBuilder(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];

    • 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

    • 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

    • addExamplesBuilder

      public SyntheticExample.Builder addExamplesBuilder()
       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];

    • addExamplesBuilder

      public SyntheticExample.Builder addExamplesBuilder(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];

    • getExamplesBuilderList

      public List<SyntheticExample.Builder> getExamplesBuilderList()
       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];