class ProjectsJobs extends Resource (View source)

The "jobs" collection of methods.

Typical usage is:

 $mlService = new Google\Service\CloudMachineLearningEngine(...);
 $jobs = $mlService->projects_jobs;

Methods

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

Cancels a running job. (jobs.cancel)

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

Creates a training or a batch prediction job. (jobs.create)

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

Describes a job. (jobs.get)

getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (jobs.getIamPolicy)

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

Lists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}.

patch(string $name, GoogleCloudMlV1Job $postBody, array $optParams = [])

Updates a specific job resource. Currently the only supported fields to update are labels. (jobs.patch)

setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (jobs.setIamPolicy)

testIamPermissions(string $resource, GoogleIamV1TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

Details

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

Cancels a running job. (jobs.cancel)

Parameters

string $name

Required. The name of the job to cancel.

GoogleCloudMlV1CancelJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

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

Creates a training or a batch prediction job. (jobs.create)

Parameters

string $parent

Required. The project name.

GoogleCloudMlV1Job $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudMlV1Job

Exceptions

Exception

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

Describes a job. (jobs.get)

Parameters

string $name

Required. The name of the job to get the description of.

array $optParams

Optional parameters.

Return Value

GoogleCloudMlV1Job

Exceptions

Exception

GoogleIamV1Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (jobs.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

GoogleCloudMlV1ListJobsResponse listProjectsJobs(string $parent, array $optParams = [])

Lists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}.

(jobs.listProjectsJobs)

Parameters

string $parent

Required. The name of the project for which to list jobs.

array $optParams

Optional parameters.

Return Value

GoogleCloudMlV1ListJobsResponse

Exceptions

Exception

GoogleCloudMlV1Job patch(string $name, GoogleCloudMlV1Job $postBody, array $optParams = [])

Updates a specific job resource. Currently the only supported fields to update are labels. (jobs.patch)

Parameters

string $name

Required. The job name.

GoogleCloudMlV1Job $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudMlV1Job

Exceptions

Exception

GoogleIamV1Policy setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (jobs.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

GoogleIamV1SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

GoogleIamV1TestIamPermissionsResponse testIamPermissions(string $resource, GoogleIamV1TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (jobs.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

GoogleIamV1TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleIamV1TestIamPermissionsResponse

Exceptions

Exception