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\CloudFunctions\Resource;
19
20use Google\Service\CloudFunctions\ListOperationsResponse;
21use Google\Service\CloudFunctions\Operation;
22
23/**
24 * The "operations" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $cloudfunctionsService = new Google\Service\CloudFunctions(...);
28 *   $operations = $cloudfunctionsService->operations;
29 *  </code>
30 */
31class Operations extends \Google\Service\Resource
32{
33  /**
34   * Gets the latest state of a long-running operation. Clients can use this
35   * method to poll the operation result at intervals as recommended by the API
36   * service. (operations.get)
37   *
38   * @param string $name The name of the operation resource.
39   * @param array $optParams Optional parameters.
40   * @return Operation
41   */
42  public function get($name, $optParams = [])
43  {
44    $params = ['name' => $name];
45    $params = array_merge($params, $optParams);
46    return $this->call('get', [$params], Operation::class);
47  }
48  /**
49   * Lists operations that match the specified filter in the request. If the
50   * server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the
51   * `name` binding allows API services to override the binding to use different
52   * resource name schemes, such as `users/operations`. To override the binding,
53   * API services can add a binding such as `"/v1/{name=users}/operations"` to
54   * their service configuration. For backwards compatibility, the default name
55   * includes the operations collection id, however overriding users must ensure
56   * the name binding is the parent resource, without the operations collection
57   * id. (operations.listOperations)
58   *
59   * @param array $optParams Optional parameters.
60   *
61   * @opt_param string filter Required. A filter for matching the requested
62   * operations. The supported formats of *filter* are: To query for a specific
63   * function: project:*,location:*,function:* To query for all of the latest
64   * operations for a project: project:*,latest:true
65   * @opt_param string name Must not be set.
66   * @opt_param int pageSize The maximum number of records that should be
67   * returned. Requested page size cannot exceed 100. If not set, the default page
68   * size is 100. Pagination is only supported when querying for a specific
69   * function.
70   * @opt_param string pageToken Token identifying which result to start with,
71   * which is returned by a previous list call. Pagination is only supported when
72   * querying for a specific function.
73   * @return ListOperationsResponse
74   */
75  public function listOperations($optParams = [])
76  {
77    $params = [];
78    $params = array_merge($params, $optParams);
79    return $this->call('list', [$params], ListOperationsResponse::class);
80  }
81}
82
83// Adding a class alias for backwards compatibility with the previous class name.
84class_alias(Operations::class, 'Google_Service_CloudFunctions_Resource_Operations');
85