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\Connectors\Resource;
19
20use Google\Service\Connectors\Policy;
21use Google\Service\Connectors\SetIamPolicyRequest;
22use Google\Service\Connectors\TestIamPermissionsRequest;
23use Google\Service\Connectors\TestIamPermissionsResponse;
24
25/**
26 * The "providers" collection of methods.
27 * Typical usage is:
28 *  <code>
29 *   $connectorsService = new Google\Service\Connectors(...);
30 *   $providers = $connectorsService->providers;
31 *  </code>
32 */
33class ProjectsLocationsProviders extends \Google\Service\Resource
34{
35  /**
36   * Gets the access control policy for a resource. Returns an empty policy if the
37   * resource exists and does not have a policy set. (providers.getIamPolicy)
38   *
39   * @param string $resource REQUIRED: The resource for which the policy is being
40   * requested. See the operation documentation for the appropriate value for this
41   * field.
42   * @param array $optParams Optional parameters.
43   *
44   * @opt_param int options.requestedPolicyVersion Optional. The maximum policy
45   * version that will be used to format the policy. Valid values are 0, 1, and 3.
46   * Requests specifying an invalid value will be rejected. Requests for policies
47   * with any conditional role bindings must specify version 3. Policies with no
48   * conditional role bindings may specify any valid value or leave the field
49   * unset. The policy in the response might use the policy version that you
50   * specified, or it might use a lower policy version. For example, if you
51   * specify version 3, but the policy has no conditional role bindings, the
52   * response uses version 1. To learn which resources support conditions in their
53   * IAM policies, see the [IAM
54   * documentation](https://cloud.google.com/iam/help/conditions/resource-
55   * policies).
56   * @return Policy
57   */
58  public function getIamPolicy($resource, $optParams = [])
59  {
60    $params = ['resource' => $resource];
61    $params = array_merge($params, $optParams);
62    return $this->call('getIamPolicy', [$params], Policy::class);
63  }
64  /**
65   * Sets the access control policy on the specified resource. Replaces any
66   * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and
67   * `PERMISSION_DENIED` errors. (providers.setIamPolicy)
68   *
69   * @param string $resource REQUIRED: The resource for which the policy is being
70   * specified. See the operation documentation for the appropriate value for this
71   * field.
72   * @param SetIamPolicyRequest $postBody
73   * @param array $optParams Optional parameters.
74   * @return Policy
75   */
76  public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
77  {
78    $params = ['resource' => $resource, 'postBody' => $postBody];
79    $params = array_merge($params, $optParams);
80    return $this->call('setIamPolicy', [$params], Policy::class);
81  }
82  /**
83   * Returns permissions that a caller has on the specified resource. If the
84   * resource does not exist, this will return an empty set of permissions, not a
85   * `NOT_FOUND` error. Note: This operation is designed to be used for building
86   * permission-aware UIs and command-line tools, not for authorization checking.
87   * This operation may "fail open" without warning.
88   * (providers.testIamPermissions)
89   *
90   * @param string $resource REQUIRED: The resource for which the policy detail is
91   * being requested. See the operation documentation for the appropriate value
92   * for this field.
93   * @param TestIamPermissionsRequest $postBody
94   * @param array $optParams Optional parameters.
95   * @return TestIamPermissionsResponse
96   */
97  public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
98  {
99    $params = ['resource' => $resource, 'postBody' => $postBody];
100    $params = array_merge($params, $optParams);
101    return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
102  }
103}
104
105// Adding a class alias for backwards compatibility with the previous class name.
106class_alias(ProjectsLocationsProviders::class, 'Google_Service_Connectors_Resource_ProjectsLocationsProviders');
107