v1

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

Obtain data corresponding to stages for a Spark Application.

get/v1/{+name}:searchStages

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

pageSizeinteger

Optional. Maximum number of stages (paging based on stage_id) 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 SearchSessionSparkApplicationStages call. Provide this token to retrieve the subsequent page.

parentstring

Required. Parent (Session) resource reference.

stageIdsstring[]

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

stageStatus'STAGE_STATUS_UNSPECIFIED' | 'STAGE_STATUS_ACTIVE' | 'STAGE_STATUS_COMPLETE' | 'STAGE_STATUS_FAILED' | 'STAGE_STATUS_PENDING' | 'STAGE_STATUS_SKIPPED'

Optional. List only stages in the given state.

summaryMetricsMaskstring

Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field

Response

Successful response