2022-04-22
▼ ▲ run.projects.locations.jobs.testIamPermissions
Parameter Order: resource
Description: Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:testIamPermissions
Path: v2/{+resource}:testIamPermissions
Parameters:
resource
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Location: path
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ run.projects.locations.jobs.run
HTTP Method: POST
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:run
Path: v2/{+name}:run
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Type: string
Description: Required. The full name of the Job. Format: projects/{projectnumber}/locations/{location}/jobs/{job}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Triggers creation of a new Execution of this Job.
▼ ▲ run.projects.locations.jobs.setIamPolicy
Parameter Order: resource
Path: v2/{+resource}:setIamPolicy
Description: Sets the IAM Access control policy for the specified Job. Overwrites any existing policy.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Type: string
Required: Yes
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Location: path
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:setIamPolicy
▼ ▲ run.projects.locations.jobs.list
Parameter Order: parent
Parameters:
pageToken
Description: A page token received from a previous call to ListJobs. All other parameters must match.
Location: query
Type: string
showDeleted
Type: boolean
Description: If true, returns deleted (but unexpired) resources along with active ones.
Location: query
pageSize
Location: query
Description: Maximum number of Jobs to return in this call.
Format: int32
Type: integer
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Description: Required. The location and project to list resources on. Format: projects/{projectnumber}/locations/{location}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v2/{+parent}/jobs
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs
Description: List Jobs.
▼ ▲ run.projects.locations.jobs.patch
Description: Updates a Job.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
updateMask
Location: query
Type: string
Format: google-fieldmask
Description: The list of fields to be updated.
validateOnly
Location: query
Type: boolean
Description: Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.
name
Type: string
Description: The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
allowMissing
Description: If set to true, and if the Job does not exist, it will create a new one. Caller must have both create and update permissions for this call if this is set to true.
Type: boolean
Location: query
HTTP Method: PATCH
Path: v2/{+name}
Parameter Order: name
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}
▼ ▲ run.projects.locations.jobs.delete
Parameters:
validateOnly
Description: Indicates that the request should be validated without actually deleting any resources.
Type: boolean
Location: query
name
Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Location: path
Type: string
Description: Required. The full name of the Job. Format: projects/{projectnumber}/locations/{location}/jobs/{job}
Required: Yes
force
Description: If set to true, the Job and its Executions will be deleted no matter whether any Executions are still running or not. If set to false or unset, the Job and its Executions can only be deleted if there are no running Executions. Any running Execution will fail the deletion.
Type: boolean
Location: query
etag
Location: query
Type: string
Description: A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
Path: v2/{+name}
HTTP Method: DELETE
Description: Deletes a Job.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}
▼ ▲ run.projects.locations.jobs.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}
HTTP Method: GET
Description: Gets information about a Job.
Parameter Order: name
Parameters:
name
Description: Required. The full name of the Job. Format: projects/{projectnumber}/locations/{location}/jobs/{job}
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Location: path
Required: Yes
Path: v2/{+name}
▼ ▲ run.projects.locations.jobs.create
Description: Create a Job.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
validateOnly
Location: query
Type: boolean
Description: Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.
parent
Required: Yes
Description: Required. The location and project in which this Job should be created. Format: projects/{projectnumber}/locations/{location}
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
jobId
Location: query
Description: Required. The unique identifier for the Job. The name of the job becomes {parent}/jobs/{job_id}.
Type: string
Path: v2/{+parent}/jobs
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs
Parameter Order: parent
▼ ▲ run.projects.locations.jobs.getIamPolicy
Description: Get the IAM Access Control policy currently in effect for the given Job. This result does not include any inherited policies.
Parameter Order: resource
Path: v2/{+resource}:getIamPolicy
Parameters:
resource
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Required: Yes
options.requestedPolicyVersion
Location: query
Type: integer
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Format: int32
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:getIamPolicy
HTTP Method: GET
▼ ▲ run.projects.locations.jobs.executions.tasks.list
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/tasks
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: List Tasks from an Execution of a Job.
Path: v2/{+parent}/tasks
Parameters:
showDeleted
Type: boolean
Description: If true, returns deleted (but unexpired) resources along with active ones.
Location: query
pageSize
Description: Maximum number of Tasks to return in this call.
Type: integer
Format: int32
Location: query
parent
Required: Yes
Type: string
Description: Required. The Execution from which the Tasks should be listed. To list all Tasks across Executions of a Job, use "-" instead of Execution name. To list all Tasks across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+/executions/[^/]+$
pageToken
Description: A page token received from a previous call to ListTasks. All other parameters must match.
Location: query
Type: string
HTTP Method: GET
Parameter Order: parent
▼ ▲ run.projects.locations.jobs.executions.tasks.get
Path: v2/{+name}
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/tasks/{tasksId}
Parameters:
name
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+/executions/[^/]+/tasks/[^/]+$
Description: Required. The full name of the Task. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}/tasks/{task}
Description: Gets information about a Task.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ run.projects.locations.jobs.executions.delete
Parameter Order: name
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2/{+name}
HTTP Method: DELETE
Description: Delete an Execution.
Parameters:
name
Description: Required. The name of the Execution to delete. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+/executions/[^/]+$
Required: Yes
etag
Description: A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates.
Location: query
Type: string
validateOnly
Location: query
Description: Indicates that the request should be validated without actually deleting any resources.
Type: boolean
▼ ▲ run.projects.locations.jobs.executions.get
HTTP Method: GET
Parameters:
name
Location: path
Type: string
Description: Required. The full name of the Execution. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+/executions/[^/]+$
Path: v2/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}
Description: Gets information about a Execution.
Parameter Order: name
▼ ▲ run.projects.locations.jobs.executions.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions
HTTP Method: GET
Description: List Executions from a Job.
Parameter Order: parent
Path: v2/{+parent}/executions
Parameters:
parent
Location: path
Description: Required. The Execution from which the Executions should be listed. To list all Executions across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}
Pattern: ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Required: Yes
Type: string
pageToken
Location: query
Description: A page token received from a previous call to ListExecutions. All other parameters must match.
Type: string
pageSize
Format: int32
Location: query
Type: integer
Description: Maximum number of Executions to return in this call.
showDeleted
Type: boolean
Location: query
Description: If true, returns deleted (but unexpired) resources along with active ones.