v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1362267343.4 KB
projects

Obtain list of spark jobs corresponding to a Spark Application.

get/v1/{+name}:searchJobs

Path parameters

namestring required

Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID"

Query parameters

jobIdsstring[]

Optional. List of Job IDs to filter by if provided.

jobStatus'JOB_EXECUTION_STATUS_UNSPECIFIED' | 'JOB_EXECUTION_STATUS_RUNNING' | 'JOB_EXECUTION_STATUS_SUCCEEDED' | 'JOB_EXECUTION_STATUS_FAILED' | 'JOB_EXECUTION_STATUS_UNKNOWN'

Optional. List only jobs in the specific state.

pageSizeinteger

Optional. Maximum number of jobs to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

pageTokenstring

Optional. A page token received from a previous SearchSessionSparkApplicationJobs call. Provide this token to retrieve the subsequent page.

parentstring

Required. Parent (Session) resource reference.

Response

Successful response