class ProjectsLocationsNasJobs extends Resource (View source)

The "nasJobs" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $nasJobs = $aiplatformService->projects_locations_nasJobs;

Methods

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

Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and NasJob.state is set to CANCELLED. (nasJobs.cancel)

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

Creates a NasJob (nasJobs.create)

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

Deletes a NasJob. (nasJobs.delete)

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

Gets a NasJob (nasJobs.get)

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

Lists NasJobs in a Location. (nasJobs.listProjectsLocationsNasJobs)

Details

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

Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and NasJob.state is set to CANCELLED. (nasJobs.cancel)

Parameters

string $name

Required. The name of the NasJob to cancel. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

GoogleCloudAiplatformV1CancelNasJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

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

Creates a NasJob (nasJobs.create)

Parameters

string $parent

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

GoogleCloudAiplatformV1NasJob $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1NasJob

Exceptions

Exception

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

Deletes a NasJob. (nasJobs.delete)

Parameters

string $name

Required. The name of the NasJob resource to be deleted. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Gets a NasJob (nasJobs.get)

Parameters

string $name

Required. The name of the NasJob resource. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1NasJob

Exceptions

Exception

GoogleCloudAiplatformV1ListNasJobsResponse listProjectsLocationsNasJobs(string $parent, array $optParams = [])

Lists NasJobs in a Location. (nasJobs.listProjectsLocationsNasJobs)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListNasJobsResponse

Exceptions

Exception