Cloud Dataproc API (dataproc:v1)

2024-09-25

40 removed methods

Deletions

    Methods
  • dataproc.projects.locations.batches.sparkApplications.write

      Path: v1/{+name}:write

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:write

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The fully qualified name of the spark application to write data about in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Write wrapper objects from dataplane to spanner

  • dataproc.projects.locations.batches.sparkApplications.search

      Path: v1/{+parent}/sparkApplications:search

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications:search

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+$

          Location: path

          Required: Yes

          Type: string

        applicationStatus

          Description: Optional. Search only applications in the chosen state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • APPLICATION_STATUS_UNSPECIFIED
        • APPLICATION_STATUS_RUNNING
        • APPLICATION_STATUS_COMPLETED

        minTime

          Description: Optional. Earliest start timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        maxTime

          Description: Optional. Latest start timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        minEndTime

          Description: Optional. Earliest end timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        maxEndTime

          Description: Optional. Latest end timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain high level information and list of Spark Applications corresponding to a batch

  • dataproc.projects.locations.batches.sparkApplications.access

      Path: v1/{+name}:access

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:access

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain high level information corresponding to a single Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.searchJobs

      Path: v1/{+name}:searchJobs

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchJobs

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        jobStatus

          Description: Optional. List only jobs in the specific state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • JOB_EXECUTION_STATUS_UNSPECIFIED
        • JOB_EXECUTION_STATUS_RUNNING
        • JOB_EXECUTION_STATUS_SUCCEEDED
        • JOB_EXECUTION_STATUS_FAILED
        • JOB_EXECUTION_STATUS_UNKNOWN

        pageSize

          Description: 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.

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain list of spark jobs corresponding to a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.accessJob

      Path: v1/{+name}:accessJob

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessJob

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        jobId

          Description: Required. Job ID to fetch data for.

          Location: query

          Type: string

          Format: int64

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a spark job for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.searchStages

      Path: v1/{+name}:searchStages

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchStages

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageStatus

          Description: Optional. List only stages in the given state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • STAGE_STATUS_UNSPECIFIED
        • STAGE_STATUS_ACTIVE
        • STAGE_STATUS_COMPLETE
        • STAGE_STATUS_FAILED
        • STAGE_STATUS_PENDING
        • STAGE_STATUS_SKIPPED

        pageSize

          Description: 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.

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

        summaryMetricsMask

          Description: 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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to stages for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.searchStageAttempts

      Path: v1/{+name}:searchStageAttempts

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchStageAttempts

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID for which attempts are to be fetched

          Location: query

          Type: string

          Format: int64

        pageSize

          Description: Optional. Maximum number of stage attempts (paging based on stage_attempt_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.

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

        summaryMetricsMask

          Description: 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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a spark stage attempts for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.accessStageAttempt

      Path: v1/{+name}:accessStageAttempt

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessStageAttempt

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Required. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

        summaryMetricsMask

          Description: 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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a spark stage attempt for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.searchStageAttemptTasks

      Path: v1/{+name}:searchStageAttemptTasks

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchStageAttemptTasks

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageId

          Description: Optional. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Optional. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

        sortRuntime

          Description: Optional. Sort the tasks by runtime.

          Location: query

          Type: boolean

        taskStatus

          Description: Optional. List only tasks in the state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • TASK_STATUS_UNSPECIFIED
        • TASK_STATUS_RUNNING
        • TASK_STATUS_SUCCESS
        • TASK_STATUS_FAILED
        • TASK_STATUS_KILLED
        • TASK_STATUS_PENDING

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to tasks for a spark stage attempt for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.searchExecutors

      Path: v1/{+name}:searchExecutors

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchExecutors

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        executorStatus

          Description: Optional. Filter to select whether active/ dead or all executors should be selected.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • EXECUTOR_STATUS_UNSPECIFIED
        • EXECUTOR_STATUS_ACTIVE
        • EXECUTOR_STATUS_DEAD

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to executors for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.searchExecutorStageSummary

      Path: v1/{+name}:searchExecutorStageSummary

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchExecutorStageSummary

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Required. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain executor summary with respect to a spark stage attempt.

  • dataproc.projects.locations.batches.sparkApplications.searchSqlQueries

      Path: v1/{+name}:searchSqlQueries

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchSqlQueries

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        details

          Description: Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.

          Location: query

          Type: boolean

        planDescription

          Description: Optional. Enables/ disables physical plan description on demand

          Location: query

          Type: boolean

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to SQL Queries for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.accessSqlQuery

      Path: v1/{+name}:accessSqlQuery

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessSqlQuery

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        executionId

          Description: Required. Execution ID

          Location: query

          Type: string

          Format: int64

        details

          Description: Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.

          Location: query

          Type: boolean

        planDescription

          Description: Optional. Enables/ disables physical plan description on demand

          Location: query

          Type: boolean

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a particular SQL Query for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.accessSqlPlan

      Path: v1/{+name}:accessSqlPlan

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessSqlPlan

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        executionId

          Description: Required. Execution ID

          Location: query

          Type: string

          Format: int64

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.

  • dataproc.projects.locations.batches.sparkApplications.accessStageRddGraph

      Path: v1/{+name}:accessStageRddGraph

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessStageRddGraph

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain RDD operation graph for a Spark Application Stage. Limits the number of clusters returned as part of the graph to 10000.

  • dataproc.projects.locations.batches.sparkApplications.accessEnvironmentInfo

      Path: v1/{+name}:accessEnvironmentInfo

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessEnvironmentInfo

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain environment details for a Spark Application

  • dataproc.projects.locations.batches.sparkApplications.summarizeJobs

      Path: v1/{+name}:summarizeJobs

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:summarizeJobs

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Jobs for a Spark Application

  • dataproc.projects.locations.batches.sparkApplications.summarizeStages

      Path: v1/{+name}:summarizeStages

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:summarizeStages

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Stages for a Spark Application

  • dataproc.projects.locations.batches.sparkApplications.summarizeStageAttemptTasks

      Path: v1/{+name}:summarizeStageAttemptTasks

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:summarizeStageAttemptTasks

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Required. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Tasks for a Spark Application Stage Attempt

  • dataproc.projects.locations.batches.sparkApplications.summarizeExecutors

      Path: v1/{+name}:summarizeExecutors

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:summarizeExecutors

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Executor Summary for a Spark Application

  • dataproc.projects.locations.sessions.sparkApplications.write

      Path: v1/{+name}:write

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:write

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The fully qualified name of the spark application to write data about in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Write wrapper objects from dataplane to spanner

  • dataproc.projects.locations.sessions.sparkApplications.search

      Path: v1/{+parent}/sparkApplications:search

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications:search

      HTTP Method: GET

      Parameters:

        parent

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

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+$

          Location: path

          Required: Yes

          Type: string

        applicationStatus

          Description: Optional. Search only applications in the chosen state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • APPLICATION_STATUS_UNSPECIFIED
        • APPLICATION_STATUS_RUNNING
        • APPLICATION_STATUS_COMPLETED

        minTime

          Description: Optional. Earliest start timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        maxTime

          Description: Optional. Latest start timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        minEndTime

          Description: Optional. Earliest end timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        maxEndTime

          Description: Optional. Latest end timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain high level information and list of Spark Applications corresponding to a batch

  • dataproc.projects.locations.sessions.sparkApplications.access

      Path: v1/{+name}:access

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:access

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain high level information corresponding to a single Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.searchJobs

      Path: v1/{+name}:searchJobs

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

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        jobStatus

          Description: Optional. List only jobs in the specific state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • JOB_EXECUTION_STATUS_UNSPECIFIED
        • JOB_EXECUTION_STATUS_RUNNING
        • JOB_EXECUTION_STATUS_SUCCEEDED
        • JOB_EXECUTION_STATUS_FAILED
        • JOB_EXECUTION_STATUS_UNKNOWN

        pageSize

          Description: 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.

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain list of spark jobs corresponding to a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.accessJob

      Path: v1/{+name}:accessJob

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessJob

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        jobId

          Description: Required. Job ID to fetch data for.

          Location: query

          Type: string

          Format: int64

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a spark job for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.searchStages

      Path: v1/{+name}:searchStages

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchStages

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageStatus

          Description: Optional. List only stages in the given state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • STAGE_STATUS_UNSPECIFIED
        • STAGE_STATUS_ACTIVE
        • STAGE_STATUS_COMPLETE
        • STAGE_STATUS_FAILED
        • STAGE_STATUS_PENDING
        • STAGE_STATUS_SKIPPED

        pageSize

          Description: 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.

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

        summaryMetricsMask

          Description: 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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to stages for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.searchStageAttempts

      Path: v1/{+name}:searchStageAttempts

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchStageAttempts

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID for which attempts are to be fetched

          Location: query

          Type: string

          Format: int64

        pageSize

          Description: Optional. Maximum number of stage attempts (paging based on stage_attempt_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.

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

        summaryMetricsMask

          Description: 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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a spark stage attempts for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.accessStageAttempt

      Path: v1/{+name}:accessStageAttempt

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessStageAttempt

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Required. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

        summaryMetricsMask

          Description: 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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a spark stage attempt for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.searchStageAttemptTasks

      Path: v1/{+name}:searchStageAttemptTasks

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchStageAttemptTasks

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageId

          Description: Optional. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Optional. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

        sortRuntime

          Description: Optional. Sort the tasks by runtime.

          Location: query

          Type: boolean

        taskStatus

          Description: Optional. List only tasks in the state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • TASK_STATUS_UNSPECIFIED
        • TASK_STATUS_RUNNING
        • TASK_STATUS_SUCCESS
        • TASK_STATUS_FAILED
        • TASK_STATUS_KILLED
        • TASK_STATUS_PENDING

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to tasks for a spark stage attempt for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.searchExecutors

      Path: v1/{+name}:searchExecutors

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchExecutors

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        executorStatus

          Description: Optional. Filter to select whether active/ dead or all executors should be selected.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • EXECUTOR_STATUS_UNSPECIFIED
        • EXECUTOR_STATUS_ACTIVE
        • EXECUTOR_STATUS_DEAD

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to executors for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.searchExecutorStageSummary

      Path: v1/{+name}:searchExecutorStageSummary

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchExecutorStageSummary

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Required. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain executor summary with respect to a spark stage attempt.

  • dataproc.projects.locations.sessions.sparkApplications.searchSqlQueries

      Path: v1/{+name}:searchSqlQueries

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchSqlQueries

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        details

          Description: Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.

          Location: query

          Type: boolean

        planDescription

          Description: Optional. Enables/ disables physical plan description on demand

          Location: query

          Type: boolean

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to SQL Queries for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.accessSqlQuery

      Path: v1/{+name}:accessSqlQuery

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessSqlQuery

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        executionId

          Description: Required. Execution ID

          Location: query

          Type: string

          Format: int64

        details

          Description: Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.

          Location: query

          Type: boolean

        planDescription

          Description: Optional. Enables/ disables physical plan description on demand

          Location: query

          Type: boolean

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a particular SQL Query for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.accessSqlPlan

      Path: v1/{+name}:accessSqlPlan

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessSqlPlan

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        executionId

          Description: Required. Execution ID

          Location: query

          Type: string

          Format: int64

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.

  • dataproc.projects.locations.sessions.sparkApplications.accessStageRddGraph

      Path: v1/{+name}:accessStageRddGraph

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessStageRddGraph

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain RDD operation graph for a Spark Application Stage. Limits the number of clusters returned as part of the graph to 10000.

  • dataproc.projects.locations.sessions.sparkApplications.accessEnvironmentInfo

      Path: v1/{+name}:accessEnvironmentInfo

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessEnvironmentInfo

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain environment details for a Spark Application

  • dataproc.projects.locations.sessions.sparkApplications.summarizeJobs

      Path: v1/{+name}:summarizeJobs

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeJobs

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Jobs for a Spark Application

  • dataproc.projects.locations.sessions.sparkApplications.summarizeStages

      Path: v1/{+name}:summarizeStages

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeStages

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Stages for a Spark Application

  • dataproc.projects.locations.sessions.sparkApplications.summarizeStageAttemptTasks

      Path: v1/{+name}:summarizeStageAttemptTasks

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeStageAttemptTasks

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Required. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Tasks for a Spark Application Stage Attempt

  • dataproc.projects.locations.sessions.sparkApplications.summarizeExecutors

      Path: v1/{+name}:summarizeExecutors

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeExecutors

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Executor Summary for a Spark Application

40 new methods

Additions

    Methods
  • dataproc.projects.locations.batches.sparkApplications.write

      Path: v1/{+name}:write

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:write

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The fully qualified name of the spark application to write data about in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Write wrapper objects from dataplane to spanner

  • dataproc.projects.locations.batches.sparkApplications.search

      Path: v1/{+parent}/sparkApplications:search

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications:search

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+$

          Location: path

          Required: Yes

          Type: string

        applicationStatus

          Description: Optional. Search only applications in the chosen state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • APPLICATION_STATUS_UNSPECIFIED
        • APPLICATION_STATUS_RUNNING
        • APPLICATION_STATUS_COMPLETED

        minTime

          Description: Optional. Earliest start timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        maxTime

          Description: Optional. Latest start timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        minEndTime

          Description: Optional. Earliest end timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        maxEndTime

          Description: Optional. Latest end timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain high level information and list of Spark Applications corresponding to a batch

  • dataproc.projects.locations.batches.sparkApplications.access

      Path: v1/{+name}:access

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:access

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain high level information corresponding to a single Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.searchJobs

      Path: v1/{+name}:searchJobs

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchJobs

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        jobStatus

          Description: Optional. List only jobs in the specific state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • JOB_EXECUTION_STATUS_UNSPECIFIED
        • JOB_EXECUTION_STATUS_RUNNING
        • JOB_EXECUTION_STATUS_SUCCEEDED
        • JOB_EXECUTION_STATUS_FAILED
        • JOB_EXECUTION_STATUS_UNKNOWN

        pageSize

          Description: 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.

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain list of spark jobs corresponding to a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.accessJob

      Path: v1/{+name}:accessJob

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessJob

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        jobId

          Description: Required. Job ID to fetch data for.

          Location: query

          Type: string

          Format: int64

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a spark job for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.searchStages

      Path: v1/{+name}:searchStages

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchStages

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageStatus

          Description: Optional. List only stages in the given state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • STAGE_STATUS_UNSPECIFIED
        • STAGE_STATUS_ACTIVE
        • STAGE_STATUS_COMPLETE
        • STAGE_STATUS_FAILED
        • STAGE_STATUS_PENDING
        • STAGE_STATUS_SKIPPED

        pageSize

          Description: 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.

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

        summaryMetricsMask

          Description: 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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to stages for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.searchStageAttempts

      Path: v1/{+name}:searchStageAttempts

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchStageAttempts

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID for which attempts are to be fetched

          Location: query

          Type: string

          Format: int64

        pageSize

          Description: Optional. Maximum number of stage attempts (paging based on stage_attempt_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.

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

        summaryMetricsMask

          Description: 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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a spark stage attempts for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.accessStageAttempt

      Path: v1/{+name}:accessStageAttempt

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessStageAttempt

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Required. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

        summaryMetricsMask

          Description: 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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a spark stage attempt for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.searchStageAttemptTasks

      Path: v1/{+name}:searchStageAttemptTasks

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchStageAttemptTasks

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageId

          Description: Optional. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Optional. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

        sortRuntime

          Description: Optional. Sort the tasks by runtime.

          Location: query

          Type: boolean

        taskStatus

          Description: Optional. List only tasks in the state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • TASK_STATUS_UNSPECIFIED
        • TASK_STATUS_RUNNING
        • TASK_STATUS_SUCCESS
        • TASK_STATUS_FAILED
        • TASK_STATUS_KILLED
        • TASK_STATUS_PENDING

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to tasks for a spark stage attempt for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.searchExecutors

      Path: v1/{+name}:searchExecutors

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchExecutors

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        executorStatus

          Description: Optional. Filter to select whether active/ dead or all executors should be selected.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • EXECUTOR_STATUS_UNSPECIFIED
        • EXECUTOR_STATUS_ACTIVE
        • EXECUTOR_STATUS_DEAD

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to executors for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.searchExecutorStageSummary

      Path: v1/{+name}:searchExecutorStageSummary

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchExecutorStageSummary

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Required. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain executor summary with respect to a spark stage attempt.

  • dataproc.projects.locations.batches.sparkApplications.searchSqlQueries

      Path: v1/{+name}:searchSqlQueries

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchSqlQueries

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        details

          Description: Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.

          Location: query

          Type: boolean

        planDescription

          Description: Optional. Enables/ disables physical plan description on demand

          Location: query

          Type: boolean

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to SQL Queries for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.accessSqlQuery

      Path: v1/{+name}:accessSqlQuery

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessSqlQuery

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        executionId

          Description: Required. Execution ID

          Location: query

          Type: string

          Format: int64

        details

          Description: Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.

          Location: query

          Type: boolean

        planDescription

          Description: Optional. Enables/ disables physical plan description on demand

          Location: query

          Type: boolean

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a particular SQL Query for a Spark Application.

  • dataproc.projects.locations.batches.sparkApplications.accessSqlPlan

      Path: v1/{+name}:accessSqlPlan

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessSqlPlan

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        executionId

          Description: Required. Execution ID

          Location: query

          Type: string

          Format: int64

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.

  • dataproc.projects.locations.batches.sparkApplications.accessStageRddGraph

      Path: v1/{+name}:accessStageRddGraph

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessStageRddGraph

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain RDD operation graph for a Spark Application Stage. Limits the number of clusters returned as part of the graph to 10000.

  • dataproc.projects.locations.batches.sparkApplications.accessEnvironmentInfo

      Path: v1/{+name}:accessEnvironmentInfo

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessEnvironmentInfo

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain environment details for a Spark Application

  • dataproc.projects.locations.batches.sparkApplications.summarizeJobs

      Path: v1/{+name}:summarizeJobs

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:summarizeJobs

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Jobs for a Spark Application

  • dataproc.projects.locations.batches.sparkApplications.summarizeStages

      Path: v1/{+name}:summarizeStages

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:summarizeStages

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Stages for a Spark Application

  • dataproc.projects.locations.batches.sparkApplications.summarizeStageAttemptTasks

      Path: v1/{+name}:summarizeStageAttemptTasks

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:summarizeStageAttemptTasks

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Required. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Tasks for a Spark Application Stage Attempt

  • dataproc.projects.locations.batches.sparkApplications.summarizeExecutors

      Path: v1/{+name}:summarizeExecutors

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:summarizeExecutors

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Batch) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Executor Summary for a Spark Application

  • dataproc.projects.locations.sessions.sparkApplications.write

      Path: v1/{+name}:write

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:write

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The fully qualified name of the spark application to write data about in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Write wrapper objects from dataplane to spanner

  • dataproc.projects.locations.sessions.sparkApplications.search

      Path: v1/{+parent}/sparkApplications:search

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications:search

      HTTP Method: GET

      Parameters:

        parent

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

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+$

          Location: path

          Required: Yes

          Type: string

        applicationStatus

          Description: Optional. Search only applications in the chosen state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • APPLICATION_STATUS_UNSPECIFIED
        • APPLICATION_STATUS_RUNNING
        • APPLICATION_STATUS_COMPLETED

        minTime

          Description: Optional. Earliest start timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        maxTime

          Description: Optional. Latest start timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        minEndTime

          Description: Optional. Earliest end timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        maxEndTime

          Description: Optional. Latest end timestamp to list.

          Location: query

          Type: string

          Format: google-datetime

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain high level information and list of Spark Applications corresponding to a batch

  • dataproc.projects.locations.sessions.sparkApplications.access

      Path: v1/{+name}:access

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:access

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain high level information corresponding to a single Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.searchJobs

      Path: v1/{+name}:searchJobs

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

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        jobStatus

          Description: Optional. List only jobs in the specific state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • JOB_EXECUTION_STATUS_UNSPECIFIED
        • JOB_EXECUTION_STATUS_RUNNING
        • JOB_EXECUTION_STATUS_SUCCEEDED
        • JOB_EXECUTION_STATUS_FAILED
        • JOB_EXECUTION_STATUS_UNKNOWN

        pageSize

          Description: 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.

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain list of spark jobs corresponding to a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.accessJob

      Path: v1/{+name}:accessJob

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessJob

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        jobId

          Description: Required. Job ID to fetch data for.

          Location: query

          Type: string

          Format: int64

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a spark job for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.searchStages

      Path: v1/{+name}:searchStages

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchStages

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageStatus

          Description: Optional. List only stages in the given state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • STAGE_STATUS_UNSPECIFIED
        • STAGE_STATUS_ACTIVE
        • STAGE_STATUS_COMPLETE
        • STAGE_STATUS_FAILED
        • STAGE_STATUS_PENDING
        • STAGE_STATUS_SKIPPED

        pageSize

          Description: 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.

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

        summaryMetricsMask

          Description: 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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to stages for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.searchStageAttempts

      Path: v1/{+name}:searchStageAttempts

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchStageAttempts

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID for which attempts are to be fetched

          Location: query

          Type: string

          Format: int64

        pageSize

          Description: Optional. Maximum number of stage attempts (paging based on stage_attempt_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.

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

        summaryMetricsMask

          Description: 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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a spark stage attempts for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.accessStageAttempt

      Path: v1/{+name}:accessStageAttempt

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessStageAttempt

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Required. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

        summaryMetricsMask

          Description: 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

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a spark stage attempt for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.searchStageAttemptTasks

      Path: v1/{+name}:searchStageAttemptTasks

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchStageAttemptTasks

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageId

          Description: Optional. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Optional. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

        sortRuntime

          Description: Optional. Sort the tasks by runtime.

          Location: query

          Type: boolean

        taskStatus

          Description: Optional. List only tasks in the state.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • TASK_STATUS_UNSPECIFIED
        • TASK_STATUS_RUNNING
        • TASK_STATUS_SUCCESS
        • TASK_STATUS_FAILED
        • TASK_STATUS_KILLED
        • TASK_STATUS_PENDING

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to tasks for a spark stage attempt for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.searchExecutors

      Path: v1/{+name}:searchExecutors

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchExecutors

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        executorStatus

          Description: Optional. Filter to select whether active/ dead or all executors should be selected.

          Location: query

          Type: string

          Enum Descriptions:

        • Enum:

        • EXECUTOR_STATUS_UNSPECIFIED
        • EXECUTOR_STATUS_ACTIVE
        • EXECUTOR_STATUS_DEAD

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to executors for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.searchExecutorStageSummary

      Path: v1/{+name}:searchExecutorStageSummary

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchExecutorStageSummary

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Required. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain executor summary with respect to a spark stage attempt.

  • dataproc.projects.locations.sessions.sparkApplications.searchSqlQueries

      Path: v1/{+name}:searchSqlQueries

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchSqlQueries

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        details

          Description: Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.

          Location: query

          Type: boolean

        planDescription

          Description: Optional. Enables/ disables physical plan description on demand

          Location: query

          Type: boolean

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to SQL Queries for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.accessSqlQuery

      Path: v1/{+name}:accessSqlQuery

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessSqlQuery

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        executionId

          Description: Required. Execution ID

          Location: query

          Type: string

          Format: int64

        details

          Description: Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.

          Location: query

          Type: boolean

        planDescription

          Description: Optional. Enables/ disables physical plan description on demand

          Location: query

          Type: boolean

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain data corresponding to a particular SQL Query for a Spark Application.

  • dataproc.projects.locations.sessions.sparkApplications.accessSqlPlan

      Path: v1/{+name}:accessSqlPlan

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessSqlPlan

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        executionId

          Description: Required. Execution ID

          Location: query

          Type: string

          Format: int64

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.

  • dataproc.projects.locations.sessions.sparkApplications.accessStageRddGraph

      Path: v1/{+name}:accessStageRddGraph

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessStageRddGraph

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain RDD operation graph for a Spark Application Stage. Limits the number of clusters returned as part of the graph to 10000.

  • dataproc.projects.locations.sessions.sparkApplications.accessEnvironmentInfo

      Path: v1/{+name}:accessEnvironmentInfo

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessEnvironmentInfo

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain environment details for a Spark Application

  • dataproc.projects.locations.sessions.sparkApplications.summarizeJobs

      Path: v1/{+name}:summarizeJobs

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeJobs

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Jobs for a Spark Application

  • dataproc.projects.locations.sessions.sparkApplications.summarizeStages

      Path: v1/{+name}:summarizeStages

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeStages

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Stages for a Spark Application

  • dataproc.projects.locations.sessions.sparkApplications.summarizeStageAttemptTasks

      Path: v1/{+name}:summarizeStageAttemptTasks

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeStageAttemptTasks

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

        stageId

          Description: Required. Stage ID

          Location: query

          Type: string

          Format: int64

        stageAttemptId

          Description: Required. Stage Attempt ID

          Location: query

          Type: integer

          Format: int32

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Tasks for a Spark Application Stage Attempt

  • dataproc.projects.locations.sessions.sparkApplications.summarizeExecutors

      Path: v1/{+name}:summarizeExecutors

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeExecutors

      HTTP Method: GET

      Parameters:

        name

          Description: 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"

          Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$

          Location: path

          Required: Yes

          Type: string

        parent

          Description: Required. Parent (Session) resource reference.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Obtain summary of Executor Summary for a Spark Application