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 |
|
---|
18 | namespace Google\Service\AccessContextManager\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\AccessContextManager\AuthorizedOrgsDesc;
|
---|
21 | use Google\Service\AccessContextManager\ListAuthorizedOrgsDescsResponse;
|
---|
22 | use Google\Service\AccessContextManager\Operation;
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * The "authorizedOrgsDescs" collection of methods.
|
---|
26 | * Typical usage is:
|
---|
27 | * <code>
|
---|
28 | * $accesscontextmanagerService = new Google\Service\AccessContextManager(...);
|
---|
29 | * $authorizedOrgsDescs = $accesscontextmanagerService->accessPolicies_authorizedOrgsDescs;
|
---|
30 | * </code>
|
---|
31 | */
|
---|
32 | class AccessPoliciesAuthorizedOrgsDescs extends \Google\Service\Resource
|
---|
33 | {
|
---|
34 | /**
|
---|
35 | * Creates an authorized orgs desc. The long-running operation from this RPC has
|
---|
36 | * a successful status after the authorized orgs desc propagates to long-lasting
|
---|
37 | * storage. If a authorized orgs desc contains errors, an error response is
|
---|
38 | * returned for the first error encountered. The name of this
|
---|
39 | * `AuthorizedOrgsDesc` will be assigned during creation.
|
---|
40 | * (authorizedOrgsDescs.create)
|
---|
41 | *
|
---|
42 | * @param string $parent Required. Resource name for the access policy which
|
---|
43 | * owns this Authorized Orgs Desc. Format: `accessPolicies/{policy_id}`
|
---|
44 | * @param AuthorizedOrgsDesc $postBody
|
---|
45 | * @param array $optParams Optional parameters.
|
---|
46 | * @return Operation
|
---|
47 | * @throws \Google\Service\Exception
|
---|
48 | */
|
---|
49 | public function create($parent, AuthorizedOrgsDesc $postBody, $optParams = [])
|
---|
50 | {
|
---|
51 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
52 | $params = array_merge($params, $optParams);
|
---|
53 | return $this->call('create', [$params], Operation::class);
|
---|
54 | }
|
---|
55 | /**
|
---|
56 | * Deletes an authorized orgs desc based on the resource name. The long-running
|
---|
57 | * operation from this RPC has a successful status after the authorized orgs
|
---|
58 | * desc is removed from long-lasting storage. (authorizedOrgsDescs.delete)
|
---|
59 | *
|
---|
60 | * @param string $name Required. Resource name for the Authorized Orgs Desc.
|
---|
61 | * Format:
|
---|
62 | * `accessPolicies/{policy_id}/authorizedOrgsDesc/{authorized_orgs_desc_id}`
|
---|
63 | * @param array $optParams Optional parameters.
|
---|
64 | * @return Operation
|
---|
65 | * @throws \Google\Service\Exception
|
---|
66 | */
|
---|
67 | public function delete($name, $optParams = [])
|
---|
68 | {
|
---|
69 | $params = ['name' => $name];
|
---|
70 | $params = array_merge($params, $optParams);
|
---|
71 | return $this->call('delete', [$params], Operation::class);
|
---|
72 | }
|
---|
73 | /**
|
---|
74 | * Gets an authorized orgs desc based on the resource name.
|
---|
75 | * (authorizedOrgsDescs.get)
|
---|
76 | *
|
---|
77 | * @param string $name Required. Resource name for the Authorized Orgs Desc.
|
---|
78 | * Format:
|
---|
79 | * `accessPolicies/{policy_id}/authorizedOrgsDescs/{authorized_orgs_descs_id}`
|
---|
80 | * @param array $optParams Optional parameters.
|
---|
81 | * @return AuthorizedOrgsDesc
|
---|
82 | * @throws \Google\Service\Exception
|
---|
83 | */
|
---|
84 | public function get($name, $optParams = [])
|
---|
85 | {
|
---|
86 | $params = ['name' => $name];
|
---|
87 | $params = array_merge($params, $optParams);
|
---|
88 | return $this->call('get', [$params], AuthorizedOrgsDesc::class);
|
---|
89 | }
|
---|
90 | /**
|
---|
91 | * Lists all authorized orgs descs for an access policy.
|
---|
92 | * (authorizedOrgsDescs.listAccessPoliciesAuthorizedOrgsDescs)
|
---|
93 | *
|
---|
94 | * @param string $parent Required. Resource name for the access policy to list
|
---|
95 | * Authorized Orgs Desc from. Format: `accessPolicies/{policy_id}`
|
---|
96 | * @param array $optParams Optional parameters.
|
---|
97 | *
|
---|
98 | * @opt_param int pageSize Number of Authorized Orgs Descs to include in the
|
---|
99 | * list. Default 100.
|
---|
100 | * @opt_param string pageToken Next page token for the next batch of Authorized
|
---|
101 | * Orgs Desc instances. Defaults to the first page of results.
|
---|
102 | * @return ListAuthorizedOrgsDescsResponse
|
---|
103 | * @throws \Google\Service\Exception
|
---|
104 | */
|
---|
105 | public function listAccessPoliciesAuthorizedOrgsDescs($parent, $optParams = [])
|
---|
106 | {
|
---|
107 | $params = ['parent' => $parent];
|
---|
108 | $params = array_merge($params, $optParams);
|
---|
109 | return $this->call('list', [$params], ListAuthorizedOrgsDescsResponse::class);
|
---|
110 | }
|
---|
111 | /**
|
---|
112 | * Updates an authorized orgs desc. The long-running operation from this RPC has
|
---|
113 | * a successful status after the authorized orgs desc propagates to long-lasting
|
---|
114 | * storage. If a authorized orgs desc contains errors, an error response is
|
---|
115 | * returned for the first error encountered. Only the organization list in
|
---|
116 | * `AuthorizedOrgsDesc` can be updated. The name, authorization_type, asset_type
|
---|
117 | * and authorization_direction cannot be updated. (authorizedOrgsDescs.patch)
|
---|
118 | *
|
---|
119 | * @param string $name Identifier. Resource name for the `AuthorizedOrgsDesc`.
|
---|
120 | * Format:
|
---|
121 | * `accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}`.
|
---|
122 | * The `authorized_orgs_desc` component must begin with a letter, followed by
|
---|
123 | * alphanumeric characters or `_`. After you create an `AuthorizedOrgsDesc`, you
|
---|
124 | * cannot change its `name`.
|
---|
125 | * @param AuthorizedOrgsDesc $postBody
|
---|
126 | * @param array $optParams Optional parameters.
|
---|
127 | *
|
---|
128 | * @opt_param string updateMask Required. Mask to control which fields get
|
---|
129 | * updated. Must be non-empty.
|
---|
130 | * @return Operation
|
---|
131 | * @throws \Google\Service\Exception
|
---|
132 | */
|
---|
133 | public function patch($name, AuthorizedOrgsDesc $postBody, $optParams = [])
|
---|
134 | {
|
---|
135 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
136 | $params = array_merge($params, $optParams);
|
---|
137 | return $this->call('patch', [$params], Operation::class);
|
---|
138 | }
|
---|
139 | }
|
---|
140 |
|
---|
141 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
142 | class_alias(AccessPoliciesAuthorizedOrgsDescs::class, 'Google_Service_AccessContextManager_Resource_AccessPoliciesAuthorizedOrgsDescs');
|
---|