GOgoogle
projects

GET /v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchJobs

Changed on

Obtain list of spark jobs corresponding to a Spark Application.

Request

  • Base URL
    https://dataproc.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-platform
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/dataproc
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/dataproc
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/dataproc.read-only
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/dataproc.read-only
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

projectsIdstring required
locationsIdstring required
sessionsIdstring required
sparkApplicationsIdstring required

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

nextPageTokenstring

This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationJobsRequest.

Changes

  • 99b75ef6e002Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/dataproc.read-only was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/dataproc.read-only was removed from the endpoint's security scheme Oauth2c