class ProjectsLocationsTuningJobs extends Resource (View source)

The "tuningJobs" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $tuningJobs = $aiplatformService->projects_locations_tuningJobs;

Methods

cancel(string $name, GoogleCloudAiplatformV1CancelTuningJobRequest $postBody, array $optParams = [])

Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed.

create(string $parent, GoogleCloudAiplatformV1TuningJob $postBody, array $optParams = [])

Creates a TuningJob. A created TuningJob right away will be attempted to be run. (tuningJobs.create)

get(string $name, array $optParams = [])

Gets a TuningJob. (tuningJobs.get)

listProjectsLocationsTuningJobs(string $parent, array $optParams = [])

Lists TuningJobs in a Location. (tuningJobs.listProjectsLocationsTuningJobs)

Details

GoogleProtobufEmpty cancel(string $name, GoogleCloudAiplatformV1CancelTuningJobRequest $postBody, array $optParams = [])

Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed.

Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and TuningJob.state is set to CANCELLED. (tuningJobs.cancel)

Parameters

string $name

Required. The name of the TuningJob to cancel. Format: projects/{project}/locations/{location}/tuningJobs/{tuning_job}

GoogleCloudAiplatformV1CancelTuningJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudAiplatformV1TuningJob create(string $parent, GoogleCloudAiplatformV1TuningJob $postBody, array $optParams = [])

Creates a TuningJob. A created TuningJob right away will be attempted to be run. (tuningJobs.create)

Parameters

string $parent

Required. The resource name of the Location to create the TuningJob in. Format: projects/{project}/locations/{location}

GoogleCloudAiplatformV1TuningJob $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1TuningJob

Exceptions

Exception

GoogleCloudAiplatformV1TuningJob get(string $name, array $optParams = [])

Gets a TuningJob. (tuningJobs.get)

Parameters

string $name

Required. The name of the TuningJob resource. Format: projects/{project}/locations/{location}/tuningJobs/{tuning_job}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1TuningJob

Exceptions

Exception

GoogleCloudAiplatformV1ListTuningJobsResponse listProjectsLocationsTuningJobs(string $parent, array $optParams = [])

Lists TuningJobs in a Location. (tuningJobs.listProjectsLocationsTuningJobs)

Parameters

string $parent

Required. The resource name of the Location to list the TuningJobs from. Format: projects/{project}/locations/{location}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListTuningJobsResponse

Exceptions

Exception