Constructor Detail

• TuningJob.Builder

  TuningJob.Builder()

Method Detail

• sdkHttpResponse

   abstract TuningJob.Builder sdkHttpResponse(HttpResponse sdkHttpResponse)

  Setter for sdkHttpResponse.

  sdkHttpResponse: Used to retain the full HTTP response.

• sdkHttpResponse

  @CanIgnoreReturnValue() TuningJob.Builder sdkHttpResponse(HttpResponse.Builder sdkHttpResponseBuilder)

  Setter for sdkHttpResponse builder.

  sdkHttpResponse: Used to retain the full HTTP response.

• clearSdkHttpResponse

  @CanIgnoreReturnValue() TuningJob.Builder clearSdkHttpResponse()

  Clears the value of sdkHttpResponse field.

• name

   abstract TuningJob.Builder name(String name)

  Setter for name.

  name: Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`

• clearName

  @CanIgnoreReturnValue() TuningJob.Builder clearName()

  Clears the value of name field.

• state

   abstract TuningJob.Builder state(JobState state)

  Setter for state.

  state: Output only. The detailed state of the job.

• clearState

  @CanIgnoreReturnValue() TuningJob.Builder clearState()

  Clears the value of state field.

• state

  @CanIgnoreReturnValue() TuningJob.Builder state(JobState.Known knownType)

  Setter for state given a known enum.

  state: Output only. The detailed state of the job.

• state

  @CanIgnoreReturnValue() TuningJob.Builder state(String state)

  Setter for state given a string.

  state: Output only. The detailed state of the job.

• createTime

   abstract TuningJob.Builder createTime(Instant createTime)

  Setter for createTime.

  createTime: Output only. Time when the TuningJob was created.

• clearCreateTime

  @CanIgnoreReturnValue() TuningJob.Builder clearCreateTime()

  Clears the value of createTime field.

• startTime

   abstract TuningJob.Builder startTime(Instant startTime)

  Setter for startTime.

  startTime: Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.

• clearStartTime

  @CanIgnoreReturnValue() TuningJob.Builder clearStartTime()

  Clears the value of startTime field.

• endTime

   abstract TuningJob.Builder endTime(Instant endTime)

  Setter for endTime.

  endTime: Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.

• clearEndTime

  @CanIgnoreReturnValue() TuningJob.Builder clearEndTime()

  Clears the value of endTime field.

• updateTime

   abstract TuningJob.Builder updateTime(Instant updateTime)

  Setter for updateTime.

  updateTime: Output only. Time when the TuningJob was most recently updated.

• clearUpdateTime

  @CanIgnoreReturnValue() TuningJob.Builder clearUpdateTime()

  Clears the value of updateTime field.

• error

   abstract TuningJob.Builder error(GoogleRpcStatus error)

  Setter for error.

  error: Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.

• error

  @CanIgnoreReturnValue() TuningJob.Builder error(GoogleRpcStatus.Builder errorBuilder)

  Setter for error builder.

  error: Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.

• clearError

  @CanIgnoreReturnValue() TuningJob.Builder clearError()

  Clears the value of error field.

• description

   abstract TuningJob.Builder description(String description)

  Setter for description.

  description: Optional. The description of the TuningJob.

• clearDescription

  @CanIgnoreReturnValue() TuningJob.Builder clearDescription()

  Clears the value of description field.

• baseModel

   abstract TuningJob.Builder baseModel(String baseModel)

  Setter for baseModel.

  baseModel: The base model that is being tuned. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).

• clearBaseModel

  @CanIgnoreReturnValue() TuningJob.Builder clearBaseModel()

  Clears the value of baseModel field.

• tunedModel

   abstract TuningJob.Builder tunedModel(TunedModel tunedModel)

  Setter for tunedModel.

  tunedModel: Output only. The tuned model resources associated with this TuningJob.

• tunedModel

  @CanIgnoreReturnValue() TuningJob.Builder tunedModel(TunedModel.Builder tunedModelBuilder)

  Setter for tunedModel builder.

  tunedModel: Output only. The tuned model resources associated with this TuningJob.

• clearTunedModel

  @CanIgnoreReturnValue() TuningJob.Builder clearTunedModel()

  Clears the value of tunedModel field.

• preTunedModel

   abstract TuningJob.Builder preTunedModel(PreTunedModel preTunedModel)

  Setter for preTunedModel.

  preTunedModel: The pre-tuned model for continuous tuning.

• preTunedModel

  @CanIgnoreReturnValue() TuningJob.Builder preTunedModel(PreTunedModel.Builder preTunedModelBuilder)

  Setter for preTunedModel builder.

  preTunedModel: The pre-tuned model for continuous tuning.

• clearPreTunedModel

  @CanIgnoreReturnValue() TuningJob.Builder clearPreTunedModel()

  Clears the value of preTunedModel field.

• supervisedTuningSpec

   abstract TuningJob.Builder supervisedTuningSpec(SupervisedTuningSpec supervisedTuningSpec)

  Setter for supervisedTuningSpec.

  supervisedTuningSpec: Tuning Spec for Supervised Fine Tuning.

• supervisedTuningSpec

  @CanIgnoreReturnValue() TuningJob.Builder supervisedTuningSpec(SupervisedTuningSpec.Builder supervisedTuningSpecBuilder)

  Setter for supervisedTuningSpec builder.

  supervisedTuningSpec: Tuning Spec for Supervised Fine Tuning.

• clearSupervisedTuningSpec

  @CanIgnoreReturnValue() TuningJob.Builder clearSupervisedTuningSpec()

  Clears the value of supervisedTuningSpec field.

• preferenceOptimizationSpec

   abstract TuningJob.Builder preferenceOptimizationSpec(PreferenceOptimizationSpec preferenceOptimizationSpec)

  Setter for preferenceOptimizationSpec.

  preferenceOptimizationSpec: Tuning Spec for Preference Optimization.

• preferenceOptimizationSpec

  @CanIgnoreReturnValue() TuningJob.Builder preferenceOptimizationSpec(PreferenceOptimizationSpec.Builder preferenceOptimizationSpecBuilder)

  Setter for preferenceOptimizationSpec builder.

  preferenceOptimizationSpec: Tuning Spec for Preference Optimization.

• clearPreferenceOptimizationSpec

  @CanIgnoreReturnValue() TuningJob.Builder clearPreferenceOptimizationSpec()

  Clears the value of preferenceOptimizationSpec field.

• distillationSpec

   abstract TuningJob.Builder distillationSpec(DistillationSpec distillationSpec)

  Setter for distillationSpec.

  distillationSpec: Tuning Spec for Distillation.

• distillationSpec

  @CanIgnoreReturnValue() TuningJob.Builder distillationSpec(DistillationSpec.Builder distillationSpecBuilder)

  Setter for distillationSpec builder.

  distillationSpec: Tuning Spec for Distillation.

• clearDistillationSpec

  @CanIgnoreReturnValue() TuningJob.Builder clearDistillationSpec()

  Clears the value of distillationSpec field.

• tuningDataStats

   abstract TuningJob.Builder tuningDataStats(TuningDataStats tuningDataStats)

  Setter for tuningDataStats.

  tuningDataStats: Output only. The tuning data statistics associated with this TuningJob.

• tuningDataStats

  @CanIgnoreReturnValue() TuningJob.Builder tuningDataStats(TuningDataStats.Builder tuningDataStatsBuilder)

  Setter for tuningDataStats builder.

  tuningDataStats: Output only. The tuning data statistics associated with this TuningJob.

• clearTuningDataStats

  @CanIgnoreReturnValue() TuningJob.Builder clearTuningDataStats()

  Clears the value of tuningDataStats field.

• encryptionSpec

   abstract TuningJob.Builder encryptionSpec(EncryptionSpec encryptionSpec)

  Setter for encryptionSpec.

  encryptionSpec: Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key.

• encryptionSpec

  @CanIgnoreReturnValue() TuningJob.Builder encryptionSpec(EncryptionSpec.Builder encryptionSpecBuilder)

  Setter for encryptionSpec builder.

  encryptionSpec: Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key.

• clearEncryptionSpec

  @CanIgnoreReturnValue() TuningJob.Builder clearEncryptionSpec()

  Clears the value of encryptionSpec field.

• partnerModelTuningSpec

   abstract TuningJob.Builder partnerModelTuningSpec(PartnerModelTuningSpec partnerModelTuningSpec)

  Setter for partnerModelTuningSpec.

  partnerModelTuningSpec: Tuning Spec for open sourced and third party Partner models.

• partnerModelTuningSpec

  @CanIgnoreReturnValue() TuningJob.Builder partnerModelTuningSpec(PartnerModelTuningSpec.Builder partnerModelTuningSpecBuilder)

  Setter for partnerModelTuningSpec builder.

  partnerModelTuningSpec: Tuning Spec for open sourced and third party Partner models.

• clearPartnerModelTuningSpec

  @CanIgnoreReturnValue() TuningJob.Builder clearPartnerModelTuningSpec()

  Clears the value of partnerModelTuningSpec field.

• evaluationConfig

   abstract TuningJob.Builder evaluationConfig(EvaluationConfig evaluationConfig)

  Setter for evaluationConfig.

  evaluationConfig: Evaluation config for the tuning job.

• evaluationConfig

  @CanIgnoreReturnValue() TuningJob.Builder evaluationConfig(EvaluationConfig.Builder evaluationConfigBuilder)

  Setter for evaluationConfig builder.

  evaluationConfig: Evaluation config for the tuning job.

• clearEvaluationConfig

  @CanIgnoreReturnValue() TuningJob.Builder clearEvaluationConfig()

  Clears the value of evaluationConfig field.

• customBaseModel

   abstract TuningJob.Builder customBaseModel(String customBaseModel)

  Setter for customBaseModel.

  customBaseModel: Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models.

• clearCustomBaseModel

  @CanIgnoreReturnValue() TuningJob.Builder clearCustomBaseModel()

  Clears the value of customBaseModel field.

• evaluateDatasetRuns

   abstract TuningJob.Builder evaluateDatasetRuns(List<EvaluateDatasetRun> evaluateDatasetRuns)

  Setter for evaluateDatasetRuns.

  evaluateDatasetRuns: Output only. Evaluation runs for the Tuning Job.

• evaluateDatasetRuns

  @CanIgnoreReturnValue() TuningJob.Builder evaluateDatasetRuns(Array<EvaluateDatasetRun> evaluateDatasetRuns)

  Setter for evaluateDatasetRuns.

  evaluateDatasetRuns: Output only. Evaluation runs for the Tuning Job.

• evaluateDatasetRuns

  @CanIgnoreReturnValue() TuningJob.Builder evaluateDatasetRuns(Array<EvaluateDatasetRun.Builder> evaluateDatasetRunsBuilders)

  Setter for evaluateDatasetRuns builder.

  evaluateDatasetRuns: Output only. Evaluation runs for the Tuning Job.

• clearEvaluateDatasetRuns

  @CanIgnoreReturnValue() TuningJob.Builder clearEvaluateDatasetRuns()

  Clears the value of evaluateDatasetRuns field.

• experiment

   abstract TuningJob.Builder experiment(String experiment)

  Setter for experiment.

  experiment: Output only. The Experiment associated with this TuningJob.

• clearExperiment

  @CanIgnoreReturnValue() TuningJob.Builder clearExperiment()

  Clears the value of experiment field.

• fullFineTuningSpec

   abstract TuningJob.Builder fullFineTuningSpec(FullFineTuningSpec fullFineTuningSpec)

  Setter for fullFineTuningSpec.

  fullFineTuningSpec: Tuning Spec for Full Fine Tuning.

• fullFineTuningSpec

  @CanIgnoreReturnValue() TuningJob.Builder fullFineTuningSpec(FullFineTuningSpec.Builder fullFineTuningSpecBuilder)

  Setter for fullFineTuningSpec builder.

  fullFineTuningSpec: Tuning Spec for Full Fine Tuning.

• clearFullFineTuningSpec

  @CanIgnoreReturnValue() TuningJob.Builder clearFullFineTuningSpec()

  Clears the value of fullFineTuningSpec field.

• labels

   abstract TuningJob.Builder labels(Map<String, String> labels)

  Setter for labels.

  labels: Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

• clearLabels

  @CanIgnoreReturnValue() TuningJob.Builder clearLabels()

  Clears the value of labels field.

• outputUri

   abstract TuningJob.Builder outputUri(String outputUri)

  Setter for outputUri.

  outputUri: Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models.

• clearOutputUri

  @CanIgnoreReturnValue() TuningJob.Builder clearOutputUri()

  Clears the value of outputUri field.

• pipelineJob

   abstract TuningJob.Builder pipelineJob(String pipelineJob)

  Setter for pipelineJob.

  pipelineJob: Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`.

• clearPipelineJob

  @CanIgnoreReturnValue() TuningJob.Builder clearPipelineJob()

  Clears the value of pipelineJob field.

• serviceAccount

   abstract TuningJob.Builder serviceAccount(String serviceAccount)

  Setter for serviceAccount.

  serviceAccount: The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.

• clearServiceAccount

  @CanIgnoreReturnValue() TuningJob.Builder clearServiceAccount()

  Clears the value of serviceAccount field.

• tunedModelDisplayName

   abstract TuningJob.Builder tunedModelDisplayName(String tunedModelDisplayName)

  Setter for tunedModelDisplayName.

  tunedModelDisplayName: Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.

• clearTunedModelDisplayName

  @CanIgnoreReturnValue() TuningJob.Builder clearTunedModelDisplayName()

  Clears the value of tunedModelDisplayName field.

• tuningJobState

   abstract TuningJob.Builder tuningJobState(TuningJobState tuningJobState)

  Setter for tuningJobState.

  tuningJobState: Output only. The detail state of the tuning job (while the overall `JobState` is running).

• clearTuningJobState

  @CanIgnoreReturnValue() TuningJob.Builder clearTuningJobState()

  Clears the value of tuningJobState field.

• tuningJobState

  @CanIgnoreReturnValue() TuningJob.Builder tuningJobState(TuningJobState.Known knownType)

  Setter for tuningJobState given a known enum.

  tuningJobState: Output only. The detail state of the tuning job (while the overall `JobState` is running).

• tuningJobState

  @CanIgnoreReturnValue() TuningJob.Builder tuningJobState(String tuningJobState)

  Setter for tuningJobState given a string.

  tuningJobState: Output only. The detail state of the tuning job (while the overall `JobState` is running).

• veoTuningSpec

   abstract TuningJob.Builder veoTuningSpec(VeoTuningSpec veoTuningSpec)

  Setter for veoTuningSpec.

  veoTuningSpec: Tuning Spec for Veo Tuning.

• veoTuningSpec

  @CanIgnoreReturnValue() TuningJob.Builder veoTuningSpec(VeoTuningSpec.Builder veoTuningSpecBuilder)

  Setter for veoTuningSpec builder.

  veoTuningSpec: Tuning Spec for Veo Tuning.

• clearVeoTuningSpec

  @CanIgnoreReturnValue() TuningJob.Builder clearVeoTuningSpec()

  Clears the value of veoTuningSpec field.

• distillationSamplingSpec

   abstract TuningJob.Builder distillationSamplingSpec(DistillationSamplingSpec distillationSamplingSpec)

  Setter for distillationSamplingSpec.

  distillationSamplingSpec: Optional. Spec for creating a distillation dataset.

• distillationSamplingSpec

  @CanIgnoreReturnValue() TuningJob.Builder distillationSamplingSpec(DistillationSamplingSpec.Builder distillationSamplingSpecBuilder)

  Setter for distillationSamplingSpec builder.

  distillationSamplingSpec: Optional. Spec for creating a distillation dataset.

• clearDistillationSamplingSpec

  @CanIgnoreReturnValue() TuningJob.Builder clearDistillationSamplingSpec()

  Clears the value of distillationSamplingSpec field.

• tuningJobMetadata

   abstract TuningJob.Builder tuningJobMetadata(TuningJobMetadata tuningJobMetadata)

  Setter for tuningJobMetadata.

  tuningJobMetadata: Output only. Tuning Job metadata.

• tuningJobMetadata

  @CanIgnoreReturnValue() TuningJob.Builder tuningJobMetadata(TuningJobMetadata.Builder tuningJobMetadataBuilder)

  Setter for tuningJobMetadata builder.

  tuningJobMetadata: Output only. Tuning Job metadata.

• clearTuningJobMetadata

  @CanIgnoreReturnValue() TuningJob.Builder clearTuningJobMetadata()

  Clears the value of tuningJobMetadata field.

• build

   abstract TuningJob build()