* $aiplatformService = new Google\Service\Aiplatform(...); * $batchPredictionJobs = $aiplatformService->projects_locations_batchPredictionJobs; * */ class ProjectsLocationsBatchPredictionJobs extends \Google\Service\Resource { /** * 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) * * @param string $name Required. The name of the BatchPredictionJob to cancel. * Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_p * rediction_job}` * @param GoogleCloudAiplatformV1CancelBatchPredictionJobRequest $postBody * @param array $optParams Optional parameters. * @return GoogleProtobufEmpty * @throws \Google\Service\Exception */ public function cancel($name, GoogleCloudAiplatformV1CancelBatchPredictionJobRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('cancel', [$params], GoogleProtobufEmpty::class); } /** * Creates a BatchPredictionJob. A BatchPredictionJob once created will right * away be attempted to start. (batchPredictionJobs.create) * * @param string $parent Required. The resource name of the Location to create * the BatchPredictionJob in. Format: `projects/{project}/locations/{location}` * @param GoogleCloudAiplatformV1BatchPredictionJob $postBody * @param array $optParams Optional parameters. * @return GoogleCloudAiplatformV1BatchPredictionJob * @throws \Google\Service\Exception */ public function create($parent, GoogleCloudAiplatformV1BatchPredictionJob $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], GoogleCloudAiplatformV1BatchPredictionJob::class); } /** * Deletes a BatchPredictionJob. Can only be called on jobs that already * finished. (batchPredictionJobs.delete) * * @param string $name Required. The name of the BatchPredictionJob resource to * be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJ * obs/{batch_prediction_job}` * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], GoogleLongrunningOperation::class); } /** * Gets a BatchPredictionJob (batchPredictionJobs.get) * * @param string $name Required. The name of the BatchPredictionJob resource. * Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_p * rediction_job}` * @param array $optParams Optional parameters. * @return GoogleCloudAiplatformV1BatchPredictionJob * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GoogleCloudAiplatformV1BatchPredictionJob::class); } /** * Lists BatchPredictionJobs in a Location. * (batchPredictionJobs.listProjectsLocationsBatchPredictionJobs) * * @param string $parent Required. The resource name of the Location to list the * BatchPredictionJobs from. Format: `projects/{project}/locations/{location}` * @param array $optParams Optional parameters. * * @opt_param string filter The standard list filter. Supported fields: * * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, * `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` * comparisons. `create_time` must be in RFC 3339 format. * `labels` supports * general map functions that is: `labels.key=value` - key:value equality * `labels.key:* - key existence Some examples of using the filter are: * * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT * display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * * `labels.keyA=valueA` * `labels.keyB:*` * @opt_param int pageSize The standard list page size. * @opt_param string pageToken The standard list page token. Typically obtained * via ListBatchPredictionJobsResponse.next_page_token of the previous * JobService.ListBatchPredictionJobs call. * @opt_param string readMask Mask specifying which fields to read. * @return GoogleCloudAiplatformV1ListBatchPredictionJobsResponse * @throws \Google\Service\Exception */ public function listProjectsLocationsBatchPredictionJobs($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], GoogleCloudAiplatformV1ListBatchPredictionJobsResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocationsBatchPredictionJobs::class, 'Google_Service_Aiplatform_Resource_ProjectsLocationsBatchPredictionJobs');