Package com.oracle.database.selectai.model

Class SyntheticDataSingleRequest

java.lang.Object
com.oracle.database.selectai.model.SyntheticDataSingleRequest
public final class SyntheticDataSingleRequest extends Object
Request object for generating synthetic data for a single database object.

This request groups the target database object, owner/schema, requested record count, user guidance, and synthetic-data generation parameters into one immutable request.

The SDK performs basic, deterministic validation where the constraint can be evaluated independently of Oracle Database. In particular, the objectName must not be null or blank, and recordCount, when specified, must be greater than zero. Invalid values detected by the SDK result in an IllegalArgumentException.

Database-specific, database-version-specific, and other semantic validation is delegated to DBMS_CLOUD_AI and Oracle Database. Therefore, a request that passes SDK validation may still be rejected by the database based on the requested synthetic-data operation or other database-side requirements.

See Also:

  • Method Details

    • getObjectName

      public String getObjectName()
      Returns the target database object name.
      Returns:
      target object name

    • getOwnerName

      public String getOwnerName()
      Returns the database user/schema associated with the target object.
      Returns:
      owner/schema name, or null when not set

    • getRecordCount

      public Integer getRecordCount()
      Returns the requested number of records to generate.
      Returns:
      record count, or null when not set

    • getUserPrompt

      public String getUserPrompt()
      Returns user guidance for synthetic data generation.
      Returns:
      user prompt, or null when not set

    • getParams

      public SyntheticDataParams getParams()
      Returns the synthetic data generation parameters.
      Returns:
      generation parameters, or null when not set

    • getParamsJson

      public String getParamsJson()
      Returns the synthetic data generation parameters serialized as JSON.
      Returns:
      JSON representation of the parameters, or null when parameters are not set

    • builder

      public static SyntheticDataSingleRequest.Builder builder(String objectName)
      Creates a builder for a single-object synthetic data request.

      The SDK validates the target object name when the builder is created. Database-specific validation of the target object and generation semantics is delegated to DBMS_CLOUD_AI and Oracle Database.

      Parameters:
      objectName - target database object name
      Returns:
      builder initialized with the target object name
      Throws:
      IllegalArgumentException - if objectName is null or blank