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
18namespace Google\Service\Dataflow\Resource;
19
20use Google\Service\Dataflow\StageExecutionDetails;
21
22/**
23 * The "stages" collection of methods.
24 * Typical usage is:
25 *  <code>
26 *   $dataflowService = new Google\Service\Dataflow(...);
27 *   $stages = $dataflowService->stages;
28 *  </code>
29 */
30class ProjectsLocationsJobsStages extends \Google\Service\Resource
31{
32  /**
33   * Request detailed information about the execution status of a stage of the
34   * job. EXPERIMENTAL. This API is subject to change or removal without notice.
35   * (stages.getExecutionDetails)
36   *
37   * @param string $projectId A project id.
38   * @param string $location The [regional endpoint]
39   * (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
40   * contains the job specified by job_id.
41   * @param string $jobId The job to get execution details for.
42   * @param string $stageId The stage for which to fetch information.
43   * @param array $optParams Optional parameters.
44   *
45   * @opt_param string endTime Upper time bound of work items to include, by start
46   * time.
47   * @opt_param int pageSize If specified, determines the maximum number of work
48   * items to return. If unspecified, the service may choose an appropriate
49   * default, or may return an arbitrarily large number of results.
50   * @opt_param string pageToken If supplied, this should be the value of
51   * next_page_token returned by an earlier call. This will cause the next page of
52   * results to be returned.
53   * @opt_param string startTime Lower time bound of work items to include, by
54   * start time.
55   * @return StageExecutionDetails
56   */
57  public function getExecutionDetails($projectId, $location, $jobId, $stageId, $optParams = [])
58  {
59    $params = ['projectId' => $projectId, 'location' => $location, 'jobId' => $jobId, 'stageId' => $stageId];
60    $params = array_merge($params, $optParams);
61    return $this->call('getExecutionDetails', [$params], StageExecutionDetails::class);
62  }
63}
64
65// Adding a class alias for backwards compatibility with the previous class name.
66class_alias(ProjectsLocationsJobsStages::class, 'Google_Service_Dataflow_Resource_ProjectsLocationsJobsStages');
67