blob: dafd73cb4987d69171d85da1f13522991b92c9f4 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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 -070088 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070089<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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070097 <code><a href="#list">list(pageToken=None, pageSize=None, parent=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098<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 -0700103 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700104<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 -0700107 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700108 <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 -0700115 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700116 The object takes the form of:
117
118{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700119 # 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 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent of this `AccessPolicy` in the Cloud Resource
124 # Hierarchy. Currently immutable once created. Format:
125 # `organizations/{organization_id}`
126 &quot;title&quot;: &quot;A String&quot;, # Required. Human readable title. Does not affect behavior.
127 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the `AccessPolicy`. Format:
128 # `accessPolicies/{policy_id}`
129}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700130
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 Kim65020912020-05-20 12:08:20 -0700141 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Dan O'Mearadd494642020-05-01 07:42:23 -0700142 # originally returns it. If you use the default HTTP mapping, the
143 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700144 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
145 # different programming environments, including REST APIs and RPC APIs. It is
146 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
147 # three pieces of data: error code, error message, and error details.
148 #
149 # You can find out more about this error model and how to work with it in the
150 # [API Design Guide](https://cloud.google.com/apis/design/errors).
151 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
152 # message types for APIs to use.
153 {
154 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
155 },
156 ],
157 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
158 &quot;message&quot;: &quot;A String&quot;, # 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 },
162 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
163 # contains progress information and common metadata such as create time.
164 # Some services might not provide such metadata. Any method that returns a
165 # long-running operation should document the metadata type, if any.
166 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
167 },
168 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
169 # If `true`, the operation is completed, and either `error` or `response` is
170 # available.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700171 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
172 # method returns no data on success, such as `Delete`, the response is
173 # `google.protobuf.Empty`. If the original method is standard
174 # `Get`/`Create`/`Update`, the response should be the resource. For other
175 # methods, the response should have the type `XxxResponse`, where `Xxx`
176 # is the original method name. For example, if the original method name
177 # is `TakeSnapshot()`, the inferred response type is
178 # `TakeSnapshotResponse`.
179 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
180 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700181 }</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 Kim65020912020-05-20 12:08:20 -0700205 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Dan O'Mearadd494642020-05-01 07:42:23 -0700206 # originally returns it. If you use the default HTTP mapping, the
207 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700208 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
209 # different programming environments, including REST APIs and RPC APIs. It is
210 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
211 # three pieces of data: error code, error message, and error details.
212 #
213 # You can find out more about this error model and how to work with it in the
214 # [API Design Guide](https://cloud.google.com/apis/design/errors).
215 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
216 # message types for APIs to use.
217 {
218 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
219 },
220 ],
221 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
222 &quot;message&quot;: &quot;A String&quot;, # 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 },
226 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
227 # contains progress information and common metadata such as create time.
228 # Some services might not provide such metadata. Any method that returns a
229 # long-running operation should document the metadata type, if any.
230 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
231 },
232 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
233 # If `true`, the operation is completed, and either `error` or `response` is
234 # available.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700235 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
236 # method returns no data on success, such as `Delete`, the response is
237 # `google.protobuf.Empty`. If the original method is standard
238 # `Get`/`Create`/`Update`, the response should be the resource. For other
239 # methods, the response should have the type `XxxResponse`, where `Xxx`
240 # is the original method name. For example, if the original method name
241 # is `TakeSnapshot()`, the inferred response type is
242 # `TakeSnapshotResponse`.
243 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
244 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700245 }</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
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700265 # 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.
269 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent of this `AccessPolicy` in the Cloud Resource
270 # Hierarchy. Currently immutable once created. Format:
271 # `organizations/{organization_id}`
272 &quot;title&quot;: &quot;A String&quot;, # Required. Human readable title. Does not affect behavior.
273 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the `AccessPolicy`. Format:
274 # `accessPolicies/{policy_id}`
275 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700276</div>
277
278<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700279 <code class="details" id="list">list(pageToken=None, pageSize=None, parent=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700280 <pre>List all AccessPolicies under a
281container.
282
283Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700284 pageToken: string, Next page token for the next batch of AccessPolicy instances. Defaults to
285the first page of results.
286 pageSize: integer, Number of AccessPolicy instances to include in the list. Default 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700287 parent: string, Required. Resource name for the container to list AccessPolicy instances
288from.
289
290Format:
291`organizations/{org_id}`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700292 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 -0700296
297Returns:
298 An object of the form:
299
300 { # A response to `ListAccessPoliciesRequest`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700301 &quot;accessPolicies&quot;: [ # List of the AccessPolicy instances.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700302 { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700303 # attributes to use Google Cloud services) and `ServicePerimeters` (which
304 # define regions of services able to freely pass data within a perimeter). An
305 # access policy is globally visible within an organization, and the
306 # restrictions it specifies apply to all projects within an organization.
307 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent of this `AccessPolicy` in the Cloud Resource
308 # Hierarchy. Currently immutable once created. Format:
309 # `organizations/{organization_id}`
310 &quot;title&quot;: &quot;A String&quot;, # Required. Human readable title. Does not affect behavior.
311 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the `AccessPolicy`. Format:
312 # `accessPolicies/{policy_id}`
313 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700314 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700315 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token to retrieve the next page of results. If the value is
316 # empty, no further results remain.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700317 }</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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700329 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700330 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 -0700335 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700336 <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 -0700345 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700346 The object takes the form of:
347
348{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700349 # 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.
353 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent of this `AccessPolicy` in the Cloud Resource
354 # Hierarchy. Currently immutable once created. Format:
355 # `organizations/{organization_id}`
356 &quot;title&quot;: &quot;A String&quot;, # Required. Human readable title. Does not affect behavior.
357 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the `AccessPolicy`. Format:
358 # `accessPolicies/{policy_id}`
359}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700360
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 Kim65020912020-05-20 12:08:20 -0700372 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Dan O'Mearadd494642020-05-01 07:42:23 -0700373 # originally returns it. If you use the default HTTP mapping, the
374 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700375 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
376 # different programming environments, including REST APIs and RPC APIs. It is
377 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
378 # three pieces of data: error code, error message, and error details.
379 #
380 # You can find out more about this error model and how to work with it in the
381 # [API Design Guide](https://cloud.google.com/apis/design/errors).
382 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
383 # message types for APIs to use.
384 {
385 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
386 },
387 ],
388 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
389 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
390 # user-facing error message should be localized and sent in the
391 # google.rpc.Status.details field, or localized by the client.
392 },
393 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
394 # contains progress information and common metadata such as create time.
395 # Some services might not provide such metadata. Any method that returns a
396 # long-running operation should document the metadata type, if any.
397 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
398 },
399 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
400 # If `true`, the operation is completed, and either `error` or `response` is
401 # available.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700402 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
403 # method returns no data on success, such as `Delete`, the response is
404 # `google.protobuf.Empty`. If the original method is standard
405 # `Get`/`Create`/`Update`, the response should be the resource. For other
406 # methods, the response should have the type `XxxResponse`, where `Xxx`
407 # is the original method name. For example, if the original method name
408 # is `TakeSnapshot()`, the inferred response type is
409 # `TakeSnapshotResponse`.
410 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
411 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700412 }</pre>
413</div>
414
415</body></html>