Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / accesscontextmanager_v1beta.accessPolicies.html
blob: cd42ea861cfebff2e948e542d08f7974a056a8e3 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="accesscontextmanager_v1beta.html">Access Context Manager API</a> . <a href="accesscontextmanager_v1beta.accessPolicies.html">accessPolicies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="accesscontextmanager_v1beta.accessPolicies.accessLevels.html">accessLevels()</a></code>
79</p>
80<p class="firstline">Returns the accessLevels Resource.</p>
81
82<p class="toc_element">
83 <code><a href="accesscontextmanager_v1beta.accessPolicies.servicePerimeters.html">servicePerimeters()</a></code>
84</p>
85<p class="firstline">Returns the servicePerimeters Resource.</p>
86
87<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]88 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="firstline">Create an `AccessPolicy`. Fails if this organization already has a</p>
90<p class="toc_element">
91 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
92<p class="firstline">Delete an AccessPolicy by resource</p>
93<p class="toc_element">
94 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
95<p class="firstline">Get an AccessPolicy by name.</p>
96<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98<p class="firstline">List all AccessPolicies under a</p>
99<p class="toc_element">
100 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
101<p class="firstline">Retrieves the next page of results.</p>
102<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104<p class="firstline">Update an AccessPolicy. The</p>
105<h3>Method Details</h3>
106<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]107 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 <pre>Create an `AccessPolicy`. Fails if this organization already has a
109`AccessPolicy`. The longrunning Operation will have a successful status
110once the `AccessPolicy` has propagated to long-lasting storage.
111Syntactic and basic semantic errors will be returned in `metadata` as a
112BadRequest proto.
113
114Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 The object takes the form of:
117
118{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]119 # attributes to use Google Cloud services) and `ServicePerimeters` (which
120 # define regions of services able to freely pass data within a perimeter). An
121 # access policy is globally visible within an organization, and the
122 # restrictions it specifies apply to all projects within an organization.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
124 # `accessPolicies/{policy_id}`
125 "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
126 # Hierarchy. Currently immutable once created. Format:
127 # `organizations/{organization_id}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]128 "title": "A String", # Required. Human readable title. Does not affect behavior.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 }
130
131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
135
136Returns:
137 An object of the form:
138
139 { # This resource represents a long-running operation that is the result of a
140 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 "metadata": { # Service-specific metadata associated with the operation. It typically
142 # contains progress information and common metadata such as create time.
143 # Some services might not provide such metadata. Any method that returns a
144 # long-running operation should document the metadata type, if any.
145 "a_key": "", # Properties of the object. Contains field @type with type URL.
146 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
148 # different programming environments, including REST APIs and RPC APIs. It is
149 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
150 # three pieces of data: error code, error message, and error details.
151 #
152 # You can find out more about this error model and how to work with it in the
153 # [API Design Guide](https://cloud.google.com/apis/design/errors).
154 "message": "A String", # A developer-facing error message, which should be in English. Any
155 # user-facing error message should be localized and sent in the
156 # google.rpc.Status.details field, or localized by the client.
157 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
158 "details": [ # A list of messages that carry the error details. There is a common set of
159 # message types for APIs to use.
160 {
161 "a_key": "", # Properties of the object. Contains field @type with type URL.
162 },
163 ],
164 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]165 "done": True or False, # If the value is `false`, it means the operation is still in progress.
166 # If `true`, the operation is completed, and either `error` or `response` is
167 # available.
168 "response": { # The normal response of the operation in case of success. If the original
169 # method returns no data on success, such as `Delete`, the response is
170 # `google.protobuf.Empty`. If the original method is standard
171 # `Get`/`Create`/`Update`, the response should be the resource. For other
172 # methods, the response should have the type `XxxResponse`, where `Xxx`
173 # is the original method name. For example, if the original method name
174 # is `TakeSnapshot()`, the inferred response type is
175 # `TakeSnapshotResponse`.
176 "a_key": "", # Properties of the object. Contains field @type with type URL.
177 },
178 "name": "A String", # The server-assigned name, which is only unique within the same service that
179 # originally returns it. If you use the default HTTP mapping, the
180 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 }</pre>
182</div>
183
184<div class="method">
185 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
186 <pre>Delete an AccessPolicy by resource
187name. The longrunning Operation will have a successful status once the
188AccessPolicy
189has been removed from long-lasting storage.
190
191Args:
192 name: string, Required. Resource name for the access policy to delete.
193
194Format `accessPolicies/{policy_id}` (required)
195 x__xgafv: string, V1 error format.
196 Allowed values
197 1 - v1 error format
198 2 - v2 error format
199
200Returns:
201 An object of the form:
202
203 { # This resource represents a long-running operation that is the result of a
204 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 "metadata": { # Service-specific metadata associated with the operation. It typically
206 # contains progress information and common metadata such as create time.
207 # Some services might not provide such metadata. Any method that returns a
208 # long-running operation should document the metadata type, if any.
209 "a_key": "", # Properties of the object. Contains field @type with type URL.
210 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]211 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
212 # different programming environments, including REST APIs and RPC APIs. It is
213 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
214 # three pieces of data: error code, error message, and error details.
215 #
216 # You can find out more about this error model and how to work with it in the
217 # [API Design Guide](https://cloud.google.com/apis/design/errors).
218 "message": "A String", # A developer-facing error message, which should be in English. Any
219 # user-facing error message should be localized and sent in the
220 # google.rpc.Status.details field, or localized by the client.
221 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
222 "details": [ # A list of messages that carry the error details. There is a common set of
223 # message types for APIs to use.
224 {
225 "a_key": "", # Properties of the object. Contains field @type with type URL.
226 },
227 ],
228 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]229 "done": True or False, # If the value is `false`, it means the operation is still in progress.
230 # If `true`, the operation is completed, and either `error` or `response` is
231 # available.
232 "response": { # The normal response of the operation in case of success. If the original
233 # method returns no data on success, such as `Delete`, the response is
234 # `google.protobuf.Empty`. If the original method is standard
235 # `Get`/`Create`/`Update`, the response should be the resource. For other
236 # methods, the response should have the type `XxxResponse`, where `Xxx`
237 # is the original method name. For example, if the original method name
238 # is `TakeSnapshot()`, the inferred response type is
239 # `TakeSnapshotResponse`.
240 "a_key": "", # Properties of the object. Contains field @type with type URL.
241 },
242 "name": "A String", # The server-assigned name, which is only unique within the same service that
243 # originally returns it. If you use the default HTTP mapping, the
244 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]245 }</pre>
246</div>
247
248<div class="method">
249 <code class="details" id="get">get(name, x__xgafv=None)</code>
250 <pre>Get an AccessPolicy by name.
251
252Args:
253 name: string, Required. Resource name for the access policy to get.
254
255Format `accessPolicies/{policy_id}` (required)
256 x__xgafv: string, V1 error format.
257 Allowed values
258 1 - v1 error format
259 2 - v2 error format
260
261Returns:
262 An object of the form:
263
264 { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]265 # attributes to use Google Cloud services) and `ServicePerimeters` (which
266 # define regions of services able to freely pass data within a perimeter). An
267 # access policy is globally visible within an organization, and the
268 # restrictions it specifies apply to all projects within an organization.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
270 # `accessPolicies/{policy_id}`
271 "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
272 # Hierarchy. Currently immutable once created. Format:
273 # `organizations/{organization_id}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]274 "title": "A String", # Required. Human readable title. Does not affect behavior.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]275 }</pre>
276</div>
277
278<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]279 <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]280 <pre>List all AccessPolicies under a
281container.
282
283Args:
284 parent: string, Required. Resource name for the container to list AccessPolicy instances
285from.
286
287Format:
288`organizations/{org_id}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]289 pageSize: integer, Number of AccessPolicy instances to include in the list. Default 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]290 pageToken: string, Next page token for the next batch of AccessPolicy instances. Defaults to
291the first page of results.
292 x__xgafv: string, V1 error format.
293 Allowed values
294 1 - v1 error format
295 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]296
297Returns:
298 An object of the form:
299
300 { # A response to `ListAccessPoliciesRequest`.
301 "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
302 # empty, no further results remain.
303 "accessPolicies": [ # List of the AccessPolicy instances.
304 { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]305 # attributes to use Google Cloud services) and `ServicePerimeters` (which
306 # define regions of services able to freely pass data within a perimeter). An
307 # access policy is globally visible within an organization, and the
308 # restrictions it specifies apply to all projects within an organization.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]309 "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
310 # `accessPolicies/{policy_id}`
311 "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
312 # Hierarchy. Currently immutable once created. Format:
313 # `organizations/{organization_id}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]314 "title": "A String", # Required. Human readable title. Does not affect behavior.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]315 },
316 ],
317 }</pre>
318</div>
319
320<div class="method">
321 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
322 <pre>Retrieves the next page of results.
323
324Args:
325 previous_request: The request for the previous page. (required)
326 previous_response: The response from the request for the previous page. (required)
327
328Returns:
329 A request object that you can call 'execute()' on to request the next
330 page. Returns None if there are no more items in the collection.
331 </pre>
332</div>
333
334<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]335 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]336 <pre>Update an AccessPolicy. The
337longrunning Operation from this RPC will have a successful status once the
338changes to the AccessPolicy have propagated
339to long-lasting storage. Syntactic and basic semantic errors will be
340returned in `metadata` as a BadRequest proto.
341
342Args:
343 name: string, Output only. Resource name of the `AccessPolicy`. Format:
344`accessPolicies/{policy_id}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]345 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]346 The object takes the form of:
347
348{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]349 # attributes to use Google Cloud services) and `ServicePerimeters` (which
350 # define regions of services able to freely pass data within a perimeter). An
351 # access policy is globally visible within an organization, and the
352 # restrictions it specifies apply to all projects within an organization.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]353 "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
354 # `accessPolicies/{policy_id}`
355 "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
356 # Hierarchy. Currently immutable once created. Format:
357 # `organizations/{organization_id}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]358 "title": "A String", # Required. Human readable title. Does not affect behavior.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 }
360
361 updateMask: string, Required. Mask to control which fields get updated. Must be non-empty.
362 x__xgafv: string, V1 error format.
363 Allowed values
364 1 - v1 error format
365 2 - v2 error format
366
367Returns:
368 An object of the form:
369
370 { # This resource represents a long-running operation that is the result of a
371 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]372 "metadata": { # Service-specific metadata associated with the operation. It typically
373 # contains progress information and common metadata such as create time.
374 # Some services might not provide such metadata. Any method that returns a
375 # long-running operation should document the metadata type, if any.
376 "a_key": "", # Properties of the object. Contains field @type with type URL.
377 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]378 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
379 # different programming environments, including REST APIs and RPC APIs. It is
380 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
381 # three pieces of data: error code, error message, and error details.
382 #
383 # You can find out more about this error model and how to work with it in the
384 # [API Design Guide](https://cloud.google.com/apis/design/errors).
385 "message": "A String", # A developer-facing error message, which should be in English. Any
386 # user-facing error message should be localized and sent in the
387 # google.rpc.Status.details field, or localized by the client.
388 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
389 "details": [ # A list of messages that carry the error details. There is a common set of
390 # message types for APIs to use.
391 {
392 "a_key": "", # Properties of the object. Contains field @type with type URL.
393 },
394 ],
395 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]396 "done": True or False, # If the value is `false`, it means the operation is still in progress.
397 # If `true`, the operation is completed, and either `error` or `response` is
398 # available.
399 "response": { # The normal response of the operation in case of success. If the original
400 # method returns no data on success, such as `Delete`, the response is
401 # `google.protobuf.Empty`. If the original method is standard
402 # `Get`/`Create`/`Update`, the response should be the resource. For other
403 # methods, the response should have the type `XxxResponse`, where `Xxx`
404 # is the original method name. For example, if the original method name
405 # is `TakeSnapshot()`, the inferred response type is
406 # `TakeSnapshotResponse`.
407 "a_key": "", # Properties of the object. Contains field @type with type URL.
408 },
409 "name": "A String", # The server-assigned name, which is only unique within the same service that
410 # originally returns it. If you use the default HTTP mapping, the
411 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]412 }</pre>
413</div>
414
415</body></html>