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