class ProjectsLocationsCustomJobs extends Resource (View source)

The "customJobs" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $customJobs = $aiplatformService->projects_locations_customJobs;

Methods

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

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

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

Creates a CustomJob. A created CustomJob right away will be attempted to be run. (customJobs.create)

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

Deletes a CustomJob. (customJobs.delete)

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

Gets a CustomJob. (customJobs.get)

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

Lists CustomJobs in a Location. (customJobs.listProjectsLocationsCustomJobs)

Details

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

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

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

Parameters

string $name

Required. The name of the CustomJob to cancel. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

GoogleCloudAiplatformV1CancelCustomJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

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

Creates a CustomJob. A created CustomJob right away will be attempted to be run. (customJobs.create)

Parameters

string $parent

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

GoogleCloudAiplatformV1CustomJob $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1CustomJob

Exceptions

Exception

GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a CustomJob. (customJobs.delete)

Parameters

string $name

Required. The name of the CustomJob resource to be deleted. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Gets a CustomJob. (customJobs.get)

Parameters

string $name

Required. The name of the CustomJob resource. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1CustomJob

Exceptions

Exception

GoogleCloudAiplatformV1ListCustomJobsResponse listProjectsLocationsCustomJobs(string $parent, array $optParams = [])

Lists CustomJobs in a Location. (customJobs.listProjectsLocationsCustomJobs)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListCustomJobsResponse

Exceptions

Exception