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