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\ServiceManagement\Resource;
19
20use Google\Service\ServiceManagement\ListOperationsResponse;
21use Google\Service\ServiceManagement\Operation;
22
23/**
24 * The "operations" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $servicemanagementService = new Google\Service\ServiceManagement(...);
28 *   $operations = $servicemanagementService->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 service operations that match the specified filter in the request.
50   * (operations.listOperations)
51   *
52   * @param array $optParams Optional parameters.
53   *
54   * @opt_param string filter A string for filtering Operations. The following
55   * filter fields are supported: * serviceName: Required. Only `=` operator is
56   * allowed. * startTime: The time this job was started, in ISO 8601 format.
57   * Allowed operators are `>=`, `>`, `<=`, and `<`. * status: Can be `done`,
58   * `in_progress`, or `failed`. Allowed operators are `=`, and `!=`. Filter
59   * expression supports conjunction (AND) and disjunction (OR) logical operators.
60   * However, the serviceName restriction must be at the top-level and can only be
61   * combined with other restrictions via the AND logical operator. Examples: *
62   * `serviceName={some-service}.googleapis.com` * `serviceName={some-
63   * service}.googleapis.com AND startTime>="2017-02-01"` * `serviceName={some-
64   * service}.googleapis.com AND status=done` * `serviceName={some-
65   * service}.googleapis.com AND (status=done OR startTime>="2017-02-01")`
66   * @opt_param string name Not used.
67   * @opt_param int pageSize The maximum number of operations to return. If
68   * unspecified, defaults to 50. The maximum value is 100.
69   * @opt_param string pageToken The standard list page token.
70   * @return ListOperationsResponse
71   */
72  public function listOperations($optParams = [])
73  {
74    $params = [];
75    $params = array_merge($params, $optParams);
76    return $this->call('list', [$params], ListOperationsResponse::class);
77  }
78}
79
80// Adding a class alias for backwards compatibility with the previous class name.
81class_alias(Operations::class, 'Google_Service_ServiceManagement_Resource_Operations');
82