[e3d4e0a] | 1 | <?php
|
---|
| 2 | /*
|
---|
| 3 | * Copyright 2014 Google Inc.
|
---|
| 4 | *
|
---|
| 5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
---|
| 6 | * use this file except in compliance with the License. You may obtain a copy of
|
---|
| 7 | * the License at
|
---|
| 8 | *
|
---|
| 9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
| 10 | *
|
---|
| 11 | * Unless required by applicable law or agreed to in writing, software
|
---|
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
| 13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
---|
| 14 | * License for the specific language governing permissions and limitations under
|
---|
| 15 | * the License.
|
---|
| 16 | */
|
---|
| 17 |
|
---|
| 18 | namespace Google\Service\Dataproc\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\Dataproc\AccessSessionSparkApplicationEnvironmentInfoResponse;
|
---|
| 21 | use Google\Service\Dataproc\AccessSessionSparkApplicationJobResponse;
|
---|
| 22 | use Google\Service\Dataproc\AccessSessionSparkApplicationResponse;
|
---|
| 23 | use Google\Service\Dataproc\AccessSessionSparkApplicationSqlQueryResponse;
|
---|
| 24 | use Google\Service\Dataproc\AccessSessionSparkApplicationSqlSparkPlanGraphResponse;
|
---|
| 25 | use Google\Service\Dataproc\AccessSessionSparkApplicationStageAttemptResponse;
|
---|
| 26 | use Google\Service\Dataproc\AccessSessionSparkApplicationStageRddOperationGraphResponse;
|
---|
| 27 | use Google\Service\Dataproc\SearchSessionSparkApplicationExecutorStageSummaryResponse;
|
---|
| 28 | use Google\Service\Dataproc\SearchSessionSparkApplicationExecutorsResponse;
|
---|
| 29 | use Google\Service\Dataproc\SearchSessionSparkApplicationJobsResponse;
|
---|
| 30 | use Google\Service\Dataproc\SearchSessionSparkApplicationSqlQueriesResponse;
|
---|
| 31 | use Google\Service\Dataproc\SearchSessionSparkApplicationStageAttemptTasksResponse;
|
---|
| 32 | use Google\Service\Dataproc\SearchSessionSparkApplicationStageAttemptsResponse;
|
---|
| 33 | use Google\Service\Dataproc\SearchSessionSparkApplicationStagesResponse;
|
---|
| 34 | use Google\Service\Dataproc\SearchSessionSparkApplicationsResponse;
|
---|
| 35 | use Google\Service\Dataproc\SummarizeSessionSparkApplicationExecutorsResponse;
|
---|
| 36 | use Google\Service\Dataproc\SummarizeSessionSparkApplicationJobsResponse;
|
---|
| 37 | use Google\Service\Dataproc\SummarizeSessionSparkApplicationStageAttemptTasksResponse;
|
---|
| 38 | use Google\Service\Dataproc\SummarizeSessionSparkApplicationStagesResponse;
|
---|
| 39 | use Google\Service\Dataproc\WriteSessionSparkApplicationContextRequest;
|
---|
| 40 | use Google\Service\Dataproc\WriteSessionSparkApplicationContextResponse;
|
---|
| 41 |
|
---|
| 42 | /**
|
---|
| 43 | * The "sparkApplications" collection of methods.
|
---|
| 44 | * Typical usage is:
|
---|
| 45 | * <code>
|
---|
| 46 | * $dataprocService = new Google\Service\Dataproc(...);
|
---|
| 47 | * $sparkApplications = $dataprocService->projects_locations_sessions_sparkApplications;
|
---|
| 48 | * </code>
|
---|
| 49 | */
|
---|
| 50 | class ProjectsLocationsSessionsSparkApplications extends \Google\Service\Resource
|
---|
| 51 | {
|
---|
| 52 | /**
|
---|
| 53 | * Obtain high level information corresponding to a single Spark Application.
|
---|
| 54 | * (sparkApplications.access)
|
---|
| 55 | *
|
---|
| 56 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 57 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 58 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 59 | * @param array $optParams Optional parameters.
|
---|
| 60 | *
|
---|
| 61 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 62 | * @return AccessSessionSparkApplicationResponse
|
---|
| 63 | * @throws \Google\Service\Exception
|
---|
| 64 | */
|
---|
| 65 | public function access($name, $optParams = [])
|
---|
| 66 | {
|
---|
| 67 | $params = ['name' => $name];
|
---|
| 68 | $params = array_merge($params, $optParams);
|
---|
| 69 | return $this->call('access', [$params], AccessSessionSparkApplicationResponse::class);
|
---|
| 70 | }
|
---|
| 71 | /**
|
---|
| 72 | * Obtain environment details for a Spark Application
|
---|
| 73 | * (sparkApplications.accessEnvironmentInfo)
|
---|
| 74 | *
|
---|
| 75 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 76 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 77 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 78 | * @param array $optParams Optional parameters.
|
---|
| 79 | *
|
---|
| 80 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 81 | * @return AccessSessionSparkApplicationEnvironmentInfoResponse
|
---|
| 82 | * @throws \Google\Service\Exception
|
---|
| 83 | */
|
---|
| 84 | public function accessEnvironmentInfo($name, $optParams = [])
|
---|
| 85 | {
|
---|
| 86 | $params = ['name' => $name];
|
---|
| 87 | $params = array_merge($params, $optParams);
|
---|
| 88 | return $this->call('accessEnvironmentInfo', [$params], AccessSessionSparkApplicationEnvironmentInfoResponse::class);
|
---|
| 89 | }
|
---|
| 90 | /**
|
---|
| 91 | * Obtain data corresponding to a spark job for a Spark Application.
|
---|
| 92 | * (sparkApplications.accessJob)
|
---|
| 93 | *
|
---|
| 94 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 95 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 96 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 97 | * @param array $optParams Optional parameters.
|
---|
| 98 | *
|
---|
| 99 | * @opt_param string jobId Required. Job ID to fetch data for.
|
---|
| 100 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 101 | * @return AccessSessionSparkApplicationJobResponse
|
---|
| 102 | * @throws \Google\Service\Exception
|
---|
| 103 | */
|
---|
| 104 | public function accessJob($name, $optParams = [])
|
---|
| 105 | {
|
---|
| 106 | $params = ['name' => $name];
|
---|
| 107 | $params = array_merge($params, $optParams);
|
---|
| 108 | return $this->call('accessJob', [$params], AccessSessionSparkApplicationJobResponse::class);
|
---|
| 109 | }
|
---|
| 110 | /**
|
---|
| 111 | * Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the
|
---|
| 112 | * number of clusters returned as part of the graph to 10000.
|
---|
| 113 | * (sparkApplications.accessSqlPlan)
|
---|
| 114 | *
|
---|
| 115 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 116 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 117 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 118 | * @param array $optParams Optional parameters.
|
---|
| 119 | *
|
---|
| 120 | * @opt_param string executionId Required. Execution ID
|
---|
| 121 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 122 | * @return AccessSessionSparkApplicationSqlSparkPlanGraphResponse
|
---|
| 123 | * @throws \Google\Service\Exception
|
---|
| 124 | */
|
---|
| 125 | public function accessSqlPlan($name, $optParams = [])
|
---|
| 126 | {
|
---|
| 127 | $params = ['name' => $name];
|
---|
| 128 | $params = array_merge($params, $optParams);
|
---|
| 129 | return $this->call('accessSqlPlan', [$params], AccessSessionSparkApplicationSqlSparkPlanGraphResponse::class);
|
---|
| 130 | }
|
---|
| 131 | /**
|
---|
| 132 | * Obtain data corresponding to a particular SQL Query for a Spark Application.
|
---|
| 133 | * (sparkApplications.accessSqlQuery)
|
---|
| 134 | *
|
---|
| 135 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 136 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 137 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 138 | * @param array $optParams Optional parameters.
|
---|
| 139 | *
|
---|
| 140 | * @opt_param bool details Optional. Lists/ hides details of Spark plan nodes.
|
---|
| 141 | * True is set to list and false to hide.
|
---|
| 142 | * @opt_param string executionId Required. Execution ID
|
---|
| 143 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 144 | * @opt_param bool planDescription Optional. Enables/ disables physical plan
|
---|
| 145 | * description on demand
|
---|
| 146 | * @return AccessSessionSparkApplicationSqlQueryResponse
|
---|
| 147 | * @throws \Google\Service\Exception
|
---|
| 148 | */
|
---|
| 149 | public function accessSqlQuery($name, $optParams = [])
|
---|
| 150 | {
|
---|
| 151 | $params = ['name' => $name];
|
---|
| 152 | $params = array_merge($params, $optParams);
|
---|
| 153 | return $this->call('accessSqlQuery', [$params], AccessSessionSparkApplicationSqlQueryResponse::class);
|
---|
| 154 | }
|
---|
| 155 | /**
|
---|
| 156 | * Obtain data corresponding to a spark stage attempt for a Spark Application.
|
---|
| 157 | * (sparkApplications.accessStageAttempt)
|
---|
| 158 | *
|
---|
| 159 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 160 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 161 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 162 | * @param array $optParams Optional parameters.
|
---|
| 163 | *
|
---|
| 164 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 165 | * @opt_param int stageAttemptId Required. Stage Attempt ID
|
---|
| 166 | * @opt_param string stageId Required. Stage ID
|
---|
| 167 | * @opt_param string summaryMetricsMask Optional. The list of summary metrics
|
---|
| 168 | * fields to include. Empty list will default to skip all summary metrics
|
---|
| 169 | * fields. Example, if the response should include TaskQuantileMetrics, the
|
---|
| 170 | * request should have task_quantile_metrics in summary_metrics_mask field
|
---|
| 171 | * @return AccessSessionSparkApplicationStageAttemptResponse
|
---|
| 172 | * @throws \Google\Service\Exception
|
---|
| 173 | */
|
---|
| 174 | public function accessStageAttempt($name, $optParams = [])
|
---|
| 175 | {
|
---|
| 176 | $params = ['name' => $name];
|
---|
| 177 | $params = array_merge($params, $optParams);
|
---|
| 178 | return $this->call('accessStageAttempt', [$params], AccessSessionSparkApplicationStageAttemptResponse::class);
|
---|
| 179 | }
|
---|
| 180 | /**
|
---|
| 181 | * Obtain RDD operation graph for a Spark Application Stage. Limits the number
|
---|
| 182 | * of clusters returned as part of the graph to 10000.
|
---|
| 183 | * (sparkApplications.accessStageRddGraph)
|
---|
| 184 | *
|
---|
| 185 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 186 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 187 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 188 | * @param array $optParams Optional parameters.
|
---|
| 189 | *
|
---|
| 190 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 191 | * @opt_param string stageId Required. Stage ID
|
---|
| 192 | * @return AccessSessionSparkApplicationStageRddOperationGraphResponse
|
---|
| 193 | * @throws \Google\Service\Exception
|
---|
| 194 | */
|
---|
| 195 | public function accessStageRddGraph($name, $optParams = [])
|
---|
| 196 | {
|
---|
| 197 | $params = ['name' => $name];
|
---|
| 198 | $params = array_merge($params, $optParams);
|
---|
| 199 | return $this->call('accessStageRddGraph', [$params], AccessSessionSparkApplicationStageRddOperationGraphResponse::class);
|
---|
| 200 | }
|
---|
| 201 | /**
|
---|
| 202 | * Obtain high level information and list of Spark Applications corresponding to
|
---|
| 203 | * a batch (sparkApplications.search)
|
---|
| 204 | *
|
---|
| 205 | * @param string $parent Required. The fully qualified name of the session to
|
---|
| 206 | * retrieve in the format
|
---|
| 207 | * "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID"
|
---|
| 208 | * @param array $optParams Optional parameters.
|
---|
| 209 | *
|
---|
| 210 | * @opt_param string applicationStatus Optional. Search only applications in the
|
---|
| 211 | * chosen state.
|
---|
| 212 | * @opt_param string maxEndTime Optional. Latest end timestamp to list.
|
---|
| 213 | * @opt_param string maxTime Optional. Latest start timestamp to list.
|
---|
| 214 | * @opt_param string minEndTime Optional. Earliest end timestamp to list.
|
---|
| 215 | * @opt_param string minTime Optional. Earliest start timestamp to list.
|
---|
| 216 | * @opt_param int pageSize Optional. Maximum number of applications to return in
|
---|
| 217 | * each response. The service may return fewer than this. The default page size
|
---|
| 218 | * is 10; the maximum page size is 100.
|
---|
| 219 | * @opt_param string pageToken Optional. A page token received from a previous
|
---|
| 220 | * SearchSessionSparkApplications call. Provide this token to retrieve the
|
---|
| 221 | * subsequent page.
|
---|
| 222 | * @return SearchSessionSparkApplicationsResponse
|
---|
| 223 | * @throws \Google\Service\Exception
|
---|
| 224 | */
|
---|
| 225 | public function search($parent, $optParams = [])
|
---|
| 226 | {
|
---|
| 227 | $params = ['parent' => $parent];
|
---|
| 228 | $params = array_merge($params, $optParams);
|
---|
| 229 | return $this->call('search', [$params], SearchSessionSparkApplicationsResponse::class);
|
---|
| 230 | }
|
---|
| 231 | /**
|
---|
| 232 | * Obtain executor summary with respect to a spark stage attempt.
|
---|
| 233 | * (sparkApplications.searchExecutorStageSummary)
|
---|
| 234 | *
|
---|
| 235 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 236 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 237 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 238 | * @param array $optParams Optional parameters.
|
---|
| 239 | *
|
---|
| 240 | * @opt_param int pageSize Optional. Maximum number of executors to return in
|
---|
| 241 | * each response. The service may return fewer than this. The default page size
|
---|
| 242 | * is 10; the maximum page size is 100.
|
---|
| 243 | * @opt_param string pageToken Optional. A page token received from a previous
|
---|
| 244 | * SearchSessionSparkApplicationExecutorStageSummary call. Provide this token to
|
---|
| 245 | * retrieve the subsequent page.
|
---|
| 246 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 247 | * @opt_param int stageAttemptId Required. Stage Attempt ID
|
---|
| 248 | * @opt_param string stageId Required. Stage ID
|
---|
| 249 | * @return SearchSessionSparkApplicationExecutorStageSummaryResponse
|
---|
| 250 | * @throws \Google\Service\Exception
|
---|
| 251 | */
|
---|
| 252 | public function searchExecutorStageSummary($name, $optParams = [])
|
---|
| 253 | {
|
---|
| 254 | $params = ['name' => $name];
|
---|
| 255 | $params = array_merge($params, $optParams);
|
---|
| 256 | return $this->call('searchExecutorStageSummary', [$params], SearchSessionSparkApplicationExecutorStageSummaryResponse::class);
|
---|
| 257 | }
|
---|
| 258 | /**
|
---|
| 259 | * Obtain data corresponding to executors for a Spark Application.
|
---|
| 260 | * (sparkApplications.searchExecutors)
|
---|
| 261 | *
|
---|
| 262 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 263 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 264 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 265 | * @param array $optParams Optional parameters.
|
---|
| 266 | *
|
---|
| 267 | * @opt_param string executorStatus Optional. Filter to select whether active/
|
---|
| 268 | * dead or all executors should be selected.
|
---|
| 269 | * @opt_param int pageSize Optional. Maximum number of executors to return in
|
---|
| 270 | * each response. The service may return fewer than this. The default page size
|
---|
| 271 | * is 10; the maximum page size is 100.
|
---|
| 272 | * @opt_param string pageToken Optional. A page token received from a previous
|
---|
| 273 | * SearchSessionSparkApplicationExecutors call. Provide this token to retrieve
|
---|
| 274 | * the subsequent page.
|
---|
| 275 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 276 | * @return SearchSessionSparkApplicationExecutorsResponse
|
---|
| 277 | * @throws \Google\Service\Exception
|
---|
| 278 | */
|
---|
| 279 | public function searchExecutors($name, $optParams = [])
|
---|
| 280 | {
|
---|
| 281 | $params = ['name' => $name];
|
---|
| 282 | $params = array_merge($params, $optParams);
|
---|
| 283 | return $this->call('searchExecutors', [$params], SearchSessionSparkApplicationExecutorsResponse::class);
|
---|
| 284 | }
|
---|
| 285 | /**
|
---|
| 286 | * Obtain list of spark jobs corresponding to a Spark Application.
|
---|
| 287 | * (sparkApplications.searchJobs)
|
---|
| 288 | *
|
---|
| 289 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 290 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 291 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 292 | * @param array $optParams Optional parameters.
|
---|
| 293 | *
|
---|
| 294 | * @opt_param string jobStatus Optional. List only jobs in the specific state.
|
---|
| 295 | * @opt_param int pageSize Optional. Maximum number of jobs to return in each
|
---|
| 296 | * response. The service may return fewer than this. The default page size is
|
---|
| 297 | * 10; the maximum page size is 100.
|
---|
| 298 | * @opt_param string pageToken Optional. A page token received from a previous
|
---|
| 299 | * SearchSessionSparkApplicationJobs call. Provide this token to retrieve the
|
---|
| 300 | * subsequent page.
|
---|
| 301 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 302 | * @return SearchSessionSparkApplicationJobsResponse
|
---|
| 303 | * @throws \Google\Service\Exception
|
---|
| 304 | */
|
---|
| 305 | public function searchJobs($name, $optParams = [])
|
---|
| 306 | {
|
---|
| 307 | $params = ['name' => $name];
|
---|
| 308 | $params = array_merge($params, $optParams);
|
---|
| 309 | return $this->call('searchJobs', [$params], SearchSessionSparkApplicationJobsResponse::class);
|
---|
| 310 | }
|
---|
| 311 | /**
|
---|
| 312 | * Obtain data corresponding to SQL Queries for a Spark Application.
|
---|
| 313 | * (sparkApplications.searchSqlQueries)
|
---|
| 314 | *
|
---|
| 315 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 316 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 317 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 318 | * @param array $optParams Optional parameters.
|
---|
| 319 | *
|
---|
| 320 | * @opt_param bool details Optional. Lists/ hides details of Spark plan nodes.
|
---|
| 321 | * True is set to list and false to hide.
|
---|
| 322 | * @opt_param int pageSize Optional. Maximum number of queries to return in each
|
---|
| 323 | * response. The service may return fewer than this. The default page size is
|
---|
| 324 | * 10; the maximum page size is 100.
|
---|
| 325 | * @opt_param string pageToken Optional. A page token received from a previous
|
---|
| 326 | * SearchSessionSparkApplicationSqlQueries call. Provide this token to retrieve
|
---|
| 327 | * the subsequent page.
|
---|
| 328 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 329 | * @opt_param bool planDescription Optional. Enables/ disables physical plan
|
---|
| 330 | * description on demand
|
---|
| 331 | * @return SearchSessionSparkApplicationSqlQueriesResponse
|
---|
| 332 | * @throws \Google\Service\Exception
|
---|
| 333 | */
|
---|
| 334 | public function searchSqlQueries($name, $optParams = [])
|
---|
| 335 | {
|
---|
| 336 | $params = ['name' => $name];
|
---|
| 337 | $params = array_merge($params, $optParams);
|
---|
| 338 | return $this->call('searchSqlQueries', [$params], SearchSessionSparkApplicationSqlQueriesResponse::class);
|
---|
| 339 | }
|
---|
| 340 | /**
|
---|
| 341 | * Obtain data corresponding to tasks for a spark stage attempt for a Spark
|
---|
| 342 | * Application. (sparkApplications.searchStageAttemptTasks)
|
---|
| 343 | *
|
---|
| 344 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 345 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 346 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 347 | * @param array $optParams Optional parameters.
|
---|
| 348 | *
|
---|
| 349 | * @opt_param int pageSize Optional. Maximum number of tasks to return in each
|
---|
| 350 | * response. The service may return fewer than this. The default page size is
|
---|
| 351 | * 10; the maximum page size is 100.
|
---|
| 352 | * @opt_param string pageToken Optional. A page token received from a previous
|
---|
| 353 | * SearchSessionSparkApplicationStageAttemptTasks call. Provide this token to
|
---|
| 354 | * retrieve the subsequent page.
|
---|
| 355 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 356 | * @opt_param bool sortRuntime Optional. Sort the tasks by runtime.
|
---|
| 357 | * @opt_param int stageAttemptId Optional. Stage Attempt ID
|
---|
| 358 | * @opt_param string stageId Optional. Stage ID
|
---|
| 359 | * @opt_param string taskStatus Optional. List only tasks in the state.
|
---|
| 360 | * @return SearchSessionSparkApplicationStageAttemptTasksResponse
|
---|
| 361 | * @throws \Google\Service\Exception
|
---|
| 362 | */
|
---|
| 363 | public function searchStageAttemptTasks($name, $optParams = [])
|
---|
| 364 | {
|
---|
| 365 | $params = ['name' => $name];
|
---|
| 366 | $params = array_merge($params, $optParams);
|
---|
| 367 | return $this->call('searchStageAttemptTasks', [$params], SearchSessionSparkApplicationStageAttemptTasksResponse::class);
|
---|
| 368 | }
|
---|
| 369 | /**
|
---|
| 370 | * Obtain data corresponding to a spark stage attempts for a Spark Application.
|
---|
| 371 | * (sparkApplications.searchStageAttempts)
|
---|
| 372 | *
|
---|
| 373 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 374 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 375 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 376 | * @param array $optParams Optional parameters.
|
---|
| 377 | *
|
---|
| 378 | * @opt_param int pageSize Optional. Maximum number of stage attempts (paging
|
---|
| 379 | * based on stage_attempt_id) to return in each response. The service may return
|
---|
| 380 | * fewer than this. The default page size is 10; the maximum page size is 100.
|
---|
| 381 | * @opt_param string pageToken Optional. A page token received from a previous
|
---|
| 382 | * SearchSessionSparkApplicationStageAttempts call. Provide this token to
|
---|
| 383 | * retrieve the subsequent page.
|
---|
| 384 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 385 | * @opt_param string stageId Required. Stage ID for which attempts are to be
|
---|
| 386 | * fetched
|
---|
| 387 | * @opt_param string summaryMetricsMask Optional. The list of summary metrics
|
---|
| 388 | * fields to include. Empty list will default to skip all summary metrics
|
---|
| 389 | * fields. Example, if the response should include TaskQuantileMetrics, the
|
---|
| 390 | * request should have task_quantile_metrics in summary_metrics_mask field
|
---|
| 391 | * @return SearchSessionSparkApplicationStageAttemptsResponse
|
---|
| 392 | * @throws \Google\Service\Exception
|
---|
| 393 | */
|
---|
| 394 | public function searchStageAttempts($name, $optParams = [])
|
---|
| 395 | {
|
---|
| 396 | $params = ['name' => $name];
|
---|
| 397 | $params = array_merge($params, $optParams);
|
---|
| 398 | return $this->call('searchStageAttempts', [$params], SearchSessionSparkApplicationStageAttemptsResponse::class);
|
---|
| 399 | }
|
---|
| 400 | /**
|
---|
| 401 | * Obtain data corresponding to stages for a Spark Application.
|
---|
| 402 | * (sparkApplications.searchStages)
|
---|
| 403 | *
|
---|
| 404 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 405 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 406 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 407 | * @param array $optParams Optional parameters.
|
---|
| 408 | *
|
---|
| 409 | * @opt_param int pageSize Optional. Maximum number of stages (paging based on
|
---|
| 410 | * stage_id) to return in each response. The service may return fewer than this.
|
---|
| 411 | * The default page size is 10; the maximum page size is 100.
|
---|
| 412 | * @opt_param string pageToken Optional. A page token received from a previous
|
---|
| 413 | * SearchSessionSparkApplicationStages call. Provide this token to retrieve the
|
---|
| 414 | * subsequent page.
|
---|
| 415 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 416 | * @opt_param string stageStatus Optional. List only stages in the given state.
|
---|
| 417 | * @opt_param string summaryMetricsMask Optional. The list of summary metrics
|
---|
| 418 | * fields to include. Empty list will default to skip all summary metrics
|
---|
| 419 | * fields. Example, if the response should include TaskQuantileMetrics, the
|
---|
| 420 | * request should have task_quantile_metrics in summary_metrics_mask field
|
---|
| 421 | * @return SearchSessionSparkApplicationStagesResponse
|
---|
| 422 | * @throws \Google\Service\Exception
|
---|
| 423 | */
|
---|
| 424 | public function searchStages($name, $optParams = [])
|
---|
| 425 | {
|
---|
| 426 | $params = ['name' => $name];
|
---|
| 427 | $params = array_merge($params, $optParams);
|
---|
| 428 | return $this->call('searchStages', [$params], SearchSessionSparkApplicationStagesResponse::class);
|
---|
| 429 | }
|
---|
| 430 | /**
|
---|
| 431 | * Obtain summary of Executor Summary for a Spark Application
|
---|
| 432 | * (sparkApplications.summarizeExecutors)
|
---|
| 433 | *
|
---|
| 434 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 435 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 436 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 437 | * @param array $optParams Optional parameters.
|
---|
| 438 | *
|
---|
| 439 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 440 | * @return SummarizeSessionSparkApplicationExecutorsResponse
|
---|
| 441 | * @throws \Google\Service\Exception
|
---|
| 442 | */
|
---|
| 443 | public function summarizeExecutors($name, $optParams = [])
|
---|
| 444 | {
|
---|
| 445 | $params = ['name' => $name];
|
---|
| 446 | $params = array_merge($params, $optParams);
|
---|
| 447 | return $this->call('summarizeExecutors', [$params], SummarizeSessionSparkApplicationExecutorsResponse::class);
|
---|
| 448 | }
|
---|
| 449 | /**
|
---|
| 450 | * Obtain summary of Jobs for a Spark Application
|
---|
| 451 | * (sparkApplications.summarizeJobs)
|
---|
| 452 | *
|
---|
| 453 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 454 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 455 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 456 | * @param array $optParams Optional parameters.
|
---|
| 457 | *
|
---|
| 458 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 459 | * @return SummarizeSessionSparkApplicationJobsResponse
|
---|
| 460 | * @throws \Google\Service\Exception
|
---|
| 461 | */
|
---|
| 462 | public function summarizeJobs($name, $optParams = [])
|
---|
| 463 | {
|
---|
| 464 | $params = ['name' => $name];
|
---|
| 465 | $params = array_merge($params, $optParams);
|
---|
| 466 | return $this->call('summarizeJobs', [$params], SummarizeSessionSparkApplicationJobsResponse::class);
|
---|
| 467 | }
|
---|
| 468 | /**
|
---|
| 469 | * Obtain summary of Tasks for a Spark Application Stage Attempt
|
---|
| 470 | * (sparkApplications.summarizeStageAttemptTasks)
|
---|
| 471 | *
|
---|
| 472 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 473 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 474 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 475 | * @param array $optParams Optional parameters.
|
---|
| 476 | *
|
---|
| 477 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 478 | * @opt_param int stageAttemptId Required. Stage Attempt ID
|
---|
| 479 | * @opt_param string stageId Required. Stage ID
|
---|
| 480 | * @return SummarizeSessionSparkApplicationStageAttemptTasksResponse
|
---|
| 481 | * @throws \Google\Service\Exception
|
---|
| 482 | */
|
---|
| 483 | public function summarizeStageAttemptTasks($name, $optParams = [])
|
---|
| 484 | {
|
---|
| 485 | $params = ['name' => $name];
|
---|
| 486 | $params = array_merge($params, $optParams);
|
---|
| 487 | return $this->call('summarizeStageAttemptTasks', [$params], SummarizeSessionSparkApplicationStageAttemptTasksResponse::class);
|
---|
| 488 | }
|
---|
| 489 | /**
|
---|
| 490 | * Obtain summary of Stages for a Spark Application
|
---|
| 491 | * (sparkApplications.summarizeStages)
|
---|
| 492 | *
|
---|
| 493 | * @param string $name Required. The fully qualified name of the session to
|
---|
| 494 | * retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/session
|
---|
| 495 | * s/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 496 | * @param array $optParams Optional parameters.
|
---|
| 497 | *
|
---|
| 498 | * @opt_param string parent Required. Parent (Session) resource reference.
|
---|
| 499 | * @return SummarizeSessionSparkApplicationStagesResponse
|
---|
| 500 | * @throws \Google\Service\Exception
|
---|
| 501 | */
|
---|
| 502 | public function summarizeStages($name, $optParams = [])
|
---|
| 503 | {
|
---|
| 504 | $params = ['name' => $name];
|
---|
| 505 | $params = array_merge($params, $optParams);
|
---|
| 506 | return $this->call('summarizeStages', [$params], SummarizeSessionSparkApplicationStagesResponse::class);
|
---|
| 507 | }
|
---|
| 508 | /**
|
---|
| 509 | * Write wrapper objects from dataplane to spanner (sparkApplications.write)
|
---|
| 510 | *
|
---|
| 511 | * @param string $name Required. The fully qualified name of the spark
|
---|
| 512 | * application to write data about in the format "projects/PROJECT_ID/locations/
|
---|
| 513 | * DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID"
|
---|
| 514 | * @param WriteSessionSparkApplicationContextRequest $postBody
|
---|
| 515 | * @param array $optParams Optional parameters.
|
---|
| 516 | * @return WriteSessionSparkApplicationContextResponse
|
---|
| 517 | * @throws \Google\Service\Exception
|
---|
| 518 | */
|
---|
| 519 | public function write($name, WriteSessionSparkApplicationContextRequest $postBody, $optParams = [])
|
---|
| 520 | {
|
---|
| 521 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
| 522 | $params = array_merge($params, $optParams);
|
---|
| 523 | return $this->call('write', [$params], WriteSessionSparkApplicationContextResponse::class);
|
---|
| 524 | }
|
---|
| 525 | }
|
---|
| 526 |
|
---|
| 527 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 528 | class_alias(ProjectsLocationsSessionsSparkApplications::class, 'Google_Service_Dataproc_Resource_ProjectsLocationsSessionsSparkApplications');
|
---|