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\Datapipelines\Resource;
19
20use Google\Service\Datapipelines\GoogleCloudDatapipelinesV1ListPipelinesResponse;
21
22/**
23 * The "locations" collection of methods.
24 * Typical usage is:
25 *  <code>
26 *   $datapipelinesService = new Google\Service\Datapipelines(...);
27 *   $locations = $datapipelinesService->locations;
28 *  </code>
29 */
30class ProjectsLocations extends \Google\Service\Resource
31{
32  /**
33   * Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have
34   * permission to access it. (locations.listPipelines)
35   *
36   * @param string $parent Required. The location name. For example:
37   * `projects/PROJECT_ID/locations/LOCATION_ID`.
38   * @param array $optParams Optional parameters.
39   *
40   * @opt_param string filter An expression for filtering the results of the
41   * request. If unspecified, all pipelines will be returned. Multiple filters can
42   * be applied and must be comma separated. Fields eligible for filtering are: +
43   * `type`: The type of the pipeline (streaming or batch). Allowed values are
44   * `ALL`, `BATCH`, and `STREAMING`. + `status`: The activity status of the
45   * pipeline. Allowed values are `ALL`, `ACTIVE`, `ARCHIVED`, and `PAUSED`. For
46   * example, to limit results to active batch processing pipelines:
47   * type:BATCH,status:ACTIVE
48   * @opt_param int pageSize The maximum number of entities to return. The service
49   * may return fewer than this value, even if there are additional pages. If
50   * unspecified, the max limit is yet to be determined by the backend
51   * implementation.
52   * @opt_param string pageToken A page token, received from a previous
53   * `ListPipelines` call. Provide this to retrieve the subsequent page. When
54   * paginating, all other parameters provided to `ListPipelines` must match the
55   * call that provided the page token.
56   * @return GoogleCloudDatapipelinesV1ListPipelinesResponse
57   */
58  public function listPipelines($parent, $optParams = [])
59  {
60    $params = ['parent' => $parent];
61    $params = array_merge($params, $optParams);
62    return $this->call('listPipelines', [$params], GoogleCloudDatapipelinesV1ListPipelinesResponse::class);
63  }
64}
65
66// Adding a class alias for backwards compatibility with the previous class name.
67class_alias(ProjectsLocations::class, 'Google_Service_Datapipelines_Resource_ProjectsLocations');
68