class ProjectsLocationsBatchPredictionJobs extends Resource (View source)

The "batchPredictionJobs" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $batchPredictionJobs = $aiplatformService->projects_locations_batchPredictionJobs;

Methods

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

Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to CANCELLED. Any files already outputted by the job are not deleted.

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

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. (batchPredictionJobs.create)

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

Deletes a BatchPredictionJob. Can only be called on jobs that already finished. (batchPredictionJobs.delete)

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

Gets a BatchPredictionJob (batchPredictionJobs.get)

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

Lists BatchPredictionJobs in a Location.

Details

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

Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to CANCELLED. Any files already outputted by the job are not deleted.

(batchPredictionJobs.cancel)

Parameters

string $name

Required. The name of the BatchPredictionJob to cancel. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_p rediction_job}

GoogleCloudAiplatformV1CancelBatchPredictionJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

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

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. (batchPredictionJobs.create)

Parameters

string $parent

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

GoogleCloudAiplatformV1BatchPredictionJob $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1BatchPredictionJob

Exceptions

Exception

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

Deletes a BatchPredictionJob. Can only be called on jobs that already finished. (batchPredictionJobs.delete)

Parameters

string $name

Required. The name of the BatchPredictionJob resource to be deleted. Format: projects/{project}/locations/{location}/batchPredictionJ obs/{batch_prediction_job}

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Gets a BatchPredictionJob (batchPredictionJobs.get)

Parameters

string $name

Required. The name of the BatchPredictionJob resource. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_p rediction_job}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1BatchPredictionJob

Exceptions

Exception

GoogleCloudAiplatformV1ListBatchPredictionJobsResponse listProjectsLocationsBatchPredictionJobs(string $parent, array $optParams = [])

Lists BatchPredictionJobs in a Location.

(batchPredictionJobs.listProjectsLocationsBatchPredictionJobs)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListBatchPredictionJobsResponse

Exceptions

Exception