1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudRun
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsJobs

ProjectsLocationsJobs

class ProjectsLocationsJobs extends Resource (View source)

The "jobs" collection of methods.

Typical usage is:

 $runService = new Google\Service\CloudRun(...);
 $jobs = $runService->projects_locations_jobs;

Methods

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

Creates a Job. (jobs.create)

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

Deletes a Job. (jobs.delete)

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

Gets information about a Job. (jobs.get)

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

Gets the IAM Access Control policy currently in effect for the given Job.

GoogleCloudRunV2ListJobsResponse
listProjectsLocationsJobs(string $parent, array $optParams = [])

Lists Jobs. Results are sorted by creation time, descending.

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

Updates a Job. (jobs.patch)

GoogleLongrunningOperation
run(string $name, GoogleCloudRunV2RunJobRequest $postBody, array $optParams = [])

Triggers creation of a new Execution of this Job. (jobs.run)

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

Sets the IAM Access control policy for the specified Job. Overwrites any existing policy. (jobs.setIamPolicy)

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

Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. (jobs.testIamPermissions)

Details

at line 56
GoogleLongrunningOperation create(string $parent, GoogleCloudRunV2Job $postBody, array $optParams = [])

Creates a Job. (jobs.create)

Parameters

string $parent

Required. The location and project in which this Job should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number.
GoogleCloudRunV2Job $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Deletes a Job. (jobs.delete)

Parameters

string $name

Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 93
GoogleCloudRunV2Job get(string $name, array $optParams = [])

Gets information about a Job. (jobs.get)

Parameters

string $name

Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.
array $optParams

Optional parameters.

Return Value

GoogleCloudRunV2Job

Exceptions

Exception

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

Gets the IAM Access Control policy currently in effect for the given Job.

This result does not include any inherited policies. (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

at line 147
GoogleCloudRunV2ListJobsResponse listProjectsLocationsJobs(string $parent, array $optParams = [])

Lists Jobs. Results are sorted by creation time, descending.

(jobs.listProjectsLocationsJobs)

Parameters

string $parent

Required. The location and project to list resources on. Format: projects/{project}/locations/{location}, where {project} can be project id or number.
array $optParams

Optional parameters.

Return Value

GoogleCloudRunV2ListJobsResponse

Exceptions

Exception

at line 170
GoogleLongrunningOperation patch(string $name, GoogleCloudRunV2Job $postBody, array $optParams = [])

Updates a Job. (jobs.patch)

Parameters

string $name

The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}
GoogleCloudRunV2Job $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 187
GoogleLongrunningOperation run(string $name, GoogleCloudRunV2RunJobRequest $postBody, array $optParams = [])

Triggers creation of a new Execution of this Job. (jobs.run)

Parameters

string $name

Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.
GoogleCloudRunV2RunJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Sets the IAM Access control policy for the specified Job. Overwrites any existing policy. (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

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

Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. (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