Class GenerateSyntheticDataRequest (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 GenerateSyntheticDataRequest extends GeneratedMessageV3 implements GenerateSyntheticDataRequestOrBuilder
Request message for DataFoundryService.GenerateSyntheticData.
Protobuf type google.cloud.aiplatform.v1.GenerateSyntheticDataRequest
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 COUNT_FIELD_NUMBER
Field Value
Type Description
int
public static final int EXAMPLES_FIELD_NUMBER
Field Value
Type Description
int
public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int
public static final int OUTPUT_FIELD_SPECS_FIELD_NUMBER
Field Value
Type Description
int
public static final int TASK_DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static GenerateSyntheticDataRequest getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static GenerateSyntheticDataRequest . Builder newBuilder ()
public static GenerateSyntheticDataRequest . Builder newBuilder ( GenerateSyntheticDataRequest prototype )
public static GenerateSyntheticDataRequest parseDelimitedFrom ( InputStream input )
public static GenerateSyntheticDataRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static GenerateSyntheticDataRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static GenerateSyntheticDataRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static GenerateSyntheticDataRequest parseFrom ( ByteString data )
public static GenerateSyntheticDataRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static GenerateSyntheticDataRequest parseFrom ( CodedInputStream input )
public static GenerateSyntheticDataRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static GenerateSyntheticDataRequest parseFrom ( InputStream input )
public static GenerateSyntheticDataRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static GenerateSyntheticDataRequest parseFrom ( ByteBuffer data )
public static GenerateSyntheticDataRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<GenerateSyntheticDataRequest> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
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
Type Description
int The count.
public GenerateSyntheticDataRequest getDefaultInstanceForType ()
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];
Parameter
Name Description
indexint
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];
Returns
Type Description
int
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];
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];
Parameter
Name Description
indexint
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];
Returns
Type Description
List <? extends com.google.cloud.aiplatform.v1.SyntheticExampleOrBuilder >
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) = { ... }
Returns
Type Description
String The location.
public 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) = { ... }
Returns
Type Description
ByteString The bytes for location.
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];
Parameter
Name Description
indexint
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];
Returns
Type Description
int
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];
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];
Parameter
Name Description
indexint
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];
Returns
Type Description
List <? extends com.google.cloud.aiplatform.v1.OutputFieldSpecOrBuilder >
public Parser<GenerateSyntheticDataRequest> getParserForType ()
Overrides
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public GenerateSyntheticDataRequest . StrategyCase getStrategyCase ()
public TaskDescriptionStrategy getTaskDescription ()
Generate data from a high-level task description.
.google.cloud.aiplatform.v1.TaskDescriptionStrategy task_description = 3;
public TaskDescriptionStrategyOrBuilder getTaskDescriptionOrBuilder ()
Generate data from a high-level task description.
.google.cloud.aiplatform.v1.TaskDescriptionStrategy task_description = 3;
public boolean hasTaskDescription ()
Generate data from a high-level task description.
.google.cloud.aiplatform.v1.TaskDescriptionStrategy task_description = 3;
Returns
Type Description
boolean Whether the taskDescription field is set.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public GenerateSyntheticDataRequest . Builder newBuilderForType ()
protected GenerateSyntheticDataRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public GenerateSyntheticDataRequest . 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,[]]
