Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / accesscontextmanager_v1.accessPolicies.html
blob: cfc198e83a87735369f661f9a3c32693d37e6488 [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_v1.html">Access Context Manager API</a> . <a href="accesscontextmanager_v1.accessPolicies.html">accessPolicies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="accesscontextmanager_v1.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_v1.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.
123 "etag": "A String", # Output only. An opaque identifier for the current version of the
124 # `AccessPolicy`. This will always be a strongly validated etag, meaning that
125 # two Access Polices will be identical if and only if their etags are
126 # identical. Clients should not expect this to be in any specific format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
128 # `accessPolicies/{policy_id}`
129 "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
130 # Hierarchy. Currently immutable once created. Format:
131 # `organizations/{organization_id}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]132 "title": "A String", # Required. Human readable title. Does not affect behavior.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 }
134
135 x__xgafv: string, V1 error format.
136 Allowed values
137 1 - v1 error format
138 2 - v2 error format
139
140Returns:
141 An object of the form:
142
143 { # This resource represents a long-running operation that is the result of a
144 # network API call.
145 "metadata": { # Service-specific metadata associated with the operation. It typically
146 # contains progress information and common metadata such as create time.
147 # Some services might not provide such metadata. Any method that returns a
148 # long-running operation should document the metadata type, if any.
149 "a_key": "", # Properties of the object. Contains field @type with type URL.
150 },
151 "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.
152 # different programming environments, including REST APIs and RPC APIs. It is
153 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
154 # three pieces of data: error code, error message, and error details.
155 #
156 # You can find out more about this error model and how to work with it in the
157 # [API Design Guide](https://cloud.google.com/apis/design/errors).
158 "message": "A String", # A developer-facing error message, which should be in English. Any
159 # user-facing error message should be localized and sent in the
160 # google.rpc.Status.details field, or localized by the client.
161 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
162 "details": [ # A list of messages that carry the error details. There is a common set of
163 # message types for APIs to use.
164 {
165 "a_key": "", # Properties of the object. Contains field @type with type URL.
166 },
167 ],
168 },
169 "done": True or False, # If the value is `false`, it means the operation is still in progress.
170 # If `true`, the operation is completed, and either `error` or `response` is
171 # available.
172 "response": { # The normal response of the operation in case of success. If the original
173 # method returns no data on success, such as `Delete`, the response is
174 # `google.protobuf.Empty`. If the original method is standard
175 # `Get`/`Create`/`Update`, the response should be the resource. For other
176 # methods, the response should have the type `XxxResponse`, where `Xxx`
177 # is the original method name. For example, if the original method name
178 # is `TakeSnapshot()`, the inferred response type is
179 # `TakeSnapshotResponse`.
180 "a_key": "", # Properties of the object. Contains field @type with type URL.
181 },
182 "name": "A String", # The server-assigned name, which is only unique within the same service that
183 # originally returns it. If you use the default HTTP mapping, the
184 # `name` should be a resource name ending with `operations/{unique_id}`.
185 }</pre>
186</div>
187
188<div class="method">
189 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
190 <pre>Delete an AccessPolicy by resource
191name. The longrunning Operation will have a successful status once the
192AccessPolicy
193has been removed from long-lasting storage.
194
195Args:
196 name: string, Required. Resource name for the access policy to delete.
197
198Format `accessPolicies/{policy_id}` (required)
199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
203
204Returns:
205 An object of the form:
206
207 { # This resource represents a long-running operation that is the result of a
208 # network API call.
209 "metadata": { # Service-specific metadata associated with the operation. It typically
210 # contains progress information and common metadata such as create time.
211 # Some services might not provide such metadata. Any method that returns a
212 # long-running operation should document the metadata type, if any.
213 "a_key": "", # Properties of the object. Contains field @type with type URL.
214 },
215 "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.
216 # different programming environments, including REST APIs and RPC APIs. It is
217 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
218 # three pieces of data: error code, error message, and error details.
219 #
220 # You can find out more about this error model and how to work with it in the
221 # [API Design Guide](https://cloud.google.com/apis/design/errors).
222 "message": "A String", # A developer-facing error message, which should be in English. Any
223 # user-facing error message should be localized and sent in the
224 # google.rpc.Status.details field, or localized by the client.
225 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
226 "details": [ # A list of messages that carry the error details. There is a common set of
227 # message types for APIs to use.
228 {
229 "a_key": "", # Properties of the object. Contains field @type with type URL.
230 },
231 ],
232 },
233 "done": True or False, # If the value is `false`, it means the operation is still in progress.
234 # If `true`, the operation is completed, and either `error` or `response` is
235 # available.
236 "response": { # The normal response of the operation in case of success. If the original
237 # method returns no data on success, such as `Delete`, the response is
238 # `google.protobuf.Empty`. If the original method is standard
239 # `Get`/`Create`/`Update`, the response should be the resource. For other
240 # methods, the response should have the type `XxxResponse`, where `Xxx`
241 # is the original method name. For example, if the original method name
242 # is `TakeSnapshot()`, the inferred response type is
243 # `TakeSnapshotResponse`.
244 "a_key": "", # Properties of the object. Contains field @type with type URL.
245 },
246 "name": "A String", # The server-assigned name, which is only unique within the same service that
247 # originally returns it. If you use the default HTTP mapping, the
248 # `name` should be a resource name ending with `operations/{unique_id}`.
249 }</pre>
250</div>
251
252<div class="method">
253 <code class="details" id="get">get(name, x__xgafv=None)</code>
254 <pre>Get an AccessPolicy by name.
255
256Args:
257 name: string, Required. Resource name for the access policy to get.
258
259Format `accessPolicies/{policy_id}` (required)
260 x__xgafv: string, V1 error format.
261 Allowed values
262 1 - v1 error format
263 2 - v2 error format
264
265Returns:
266 An object of the form:
267
268 { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]269 # attributes to use Google Cloud services) and `ServicePerimeters` (which
270 # define regions of services able to freely pass data within a perimeter). An
271 # access policy is globally visible within an organization, and the
272 # restrictions it specifies apply to all projects within an organization.
273 "etag": "A String", # Output only. An opaque identifier for the current version of the
274 # `AccessPolicy`. This will always be a strongly validated etag, meaning that
275 # two Access Polices will be identical if and only if their etags are
276 # identical. Clients should not expect this to be in any specific format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]277 "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
278 # `accessPolicies/{policy_id}`
279 "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
280 # Hierarchy. Currently immutable once created. Format:
281 # `organizations/{organization_id}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]282 "title": "A String", # Required. Human readable title. Does not affect behavior.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]283 }</pre>
284</div>
285
286<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]287 <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]288 <pre>List all AccessPolicies under a
289container.
290
291Args:
292 parent: string, Required. Resource name for the container to list AccessPolicy instances
293from.
294
295Format:
296`organizations/{org_id}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]297 pageSize: integer, Number of AccessPolicy instances to include in the list. Default 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]298 pageToken: string, Next page token for the next batch of AccessPolicy instances. Defaults to
299the first page of results.
300 x__xgafv: string, V1 error format.
301 Allowed values
302 1 - v1 error format
303 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]304
305Returns:
306 An object of the form:
307
308 { # A response to `ListAccessPoliciesRequest`.
309 "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
310 # empty, no further results remain.
311 "accessPolicies": [ # List of the AccessPolicy instances.
312 { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]313 # attributes to use Google Cloud services) and `ServicePerimeters` (which
314 # define regions of services able to freely pass data within a perimeter). An
315 # access policy is globally visible within an organization, and the
316 # restrictions it specifies apply to all projects within an organization.
317 "etag": "A String", # Output only. An opaque identifier for the current version of the
318 # `AccessPolicy`. This will always be a strongly validated etag, meaning that
319 # two Access Polices will be identical if and only if their etags are
320 # identical. Clients should not expect this to be in any specific format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]321 "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
322 # `accessPolicies/{policy_id}`
323 "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
324 # Hierarchy. Currently immutable once created. Format:
325 # `organizations/{organization_id}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]326 "title": "A String", # Required. Human readable title. Does not affect behavior.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]327 },
328 ],
329 }</pre>
330</div>
331
332<div class="method">
333 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
334 <pre>Retrieves the next page of results.
335
336Args:
337 previous_request: The request for the previous page. (required)
338 previous_response: The response from the request for the previous page. (required)
339
340Returns:
341 A request object that you can call 'execute()' on to request the next
342 page. Returns None if there are no more items in the collection.
343 </pre>
344</div>
345
346<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]347 <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]348 <pre>Update an AccessPolicy. The
349longrunning Operation from this RPC will have a successful status once the
350changes to the AccessPolicy have propagated
351to long-lasting storage. Syntactic and basic semantic errors will be
352returned in `metadata` as a BadRequest proto.
353
354Args:
355 name: string, Output only. Resource name of the `AccessPolicy`. Format:
356`accessPolicies/{policy_id}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]357 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]358 The object takes the form of:
359
360{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]361 # attributes to use Google Cloud services) and `ServicePerimeters` (which
362 # define regions of services able to freely pass data within a perimeter). An
363 # access policy is globally visible within an organization, and the
364 # restrictions it specifies apply to all projects within an organization.
365 "etag": "A String", # Output only. An opaque identifier for the current version of the
366 # `AccessPolicy`. This will always be a strongly validated etag, meaning that
367 # two Access Polices will be identical if and only if their etags are
368 # identical. Clients should not expect this to be in any specific format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]369 "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
370 # `accessPolicies/{policy_id}`
371 "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
372 # Hierarchy. Currently immutable once created. Format:
373 # `organizations/{organization_id}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]374 "title": "A String", # Required. Human readable title. Does not affect behavior.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]375 }
376
377 updateMask: string, Required. Mask to control which fields get updated. Must be non-empty.
378 x__xgafv: string, V1 error format.
379 Allowed values
380 1 - v1 error format
381 2 - v2 error format
382
383Returns:
384 An object of the form:
385
386 { # This resource represents a long-running operation that is the result of a
387 # network API call.
388 "metadata": { # Service-specific metadata associated with the operation. It typically
389 # contains progress information and common metadata such as create time.
390 # Some services might not provide such metadata. Any method that returns a
391 # long-running operation should document the metadata type, if any.
392 "a_key": "", # Properties of the object. Contains field @type with type URL.
393 },
394 "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.
395 # different programming environments, including REST APIs and RPC APIs. It is
396 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
397 # three pieces of data: error code, error message, and error details.
398 #
399 # You can find out more about this error model and how to work with it in the
400 # [API Design Guide](https://cloud.google.com/apis/design/errors).
401 "message": "A String", # A developer-facing error message, which should be in English. Any
402 # user-facing error message should be localized and sent in the
403 # google.rpc.Status.details field, or localized by the client.
404 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
405 "details": [ # A list of messages that carry the error details. There is a common set of
406 # message types for APIs to use.
407 {
408 "a_key": "", # Properties of the object. Contains field @type with type URL.
409 },
410 ],
411 },
412 "done": True or False, # If the value is `false`, it means the operation is still in progress.
413 # If `true`, the operation is completed, and either `error` or `response` is
414 # available.
415 "response": { # The normal response of the operation in case of success. If the original
416 # method returns no data on success, such as `Delete`, the response is
417 # `google.protobuf.Empty`. If the original method is standard
418 # `Get`/`Create`/`Update`, the response should be the resource. For other
419 # methods, the response should have the type `XxxResponse`, where `Xxx`
420 # is the original method name. For example, if the original method name
421 # is `TakeSnapshot()`, the inferred response type is
422 # `TakeSnapshotResponse`.
423 "a_key": "", # Properties of the object. Contains field @type with type URL.
424 },
425 "name": "A String", # The server-assigned name, which is only unique within the same service that
426 # originally returns it. If you use the default HTTP mapping, the
427 # `name` should be a resource name ending with `operations/{unique_id}`.
428 }</pre>
429</div>
430
431</body></html>