blob: 30ca5772926884034d45ee03c2cfddab8bdb6674 [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_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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
90<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070091 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070092<p class="firstline">Create an `AccessPolicy`. Fails if this organization already has a `AccessPolicy`. The longrunning Operation will have a successful status once the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070093<p class="toc_element">
94 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070095<p class="firstline">Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070096<p class="toc_element">
97 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
98<p class="firstline">Get an AccessPolicy by name.</p>
99<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800100 <code><a href="#list">list(pageSize=None, pageToken=None, parent=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700101<p class="firstline">List all AccessPolicies under a container.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700102<p class="toc_element">
103 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
104<p class="firstline">Retrieves the next page of results.</p>
105<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700106 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700107<p class="firstline">Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700108<h3>Method Details</h3>
109<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700110 <code class="details" id="close">close()</code>
111 <pre>Close httplib2 connections.</pre>
112</div>
113
114<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700115 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700116 <pre>Create an `AccessPolicy`. Fails if this organization already has a `AccessPolicy`. The longrunning Operation will have a successful status once the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700117
118Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700119 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120 The object takes the form of:
121
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700122{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800123 &quot;etag&quot;: &quot;A String&quot;, # Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700124 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}`
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800125 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`
126 &quot;title&quot;: &quot;A String&quot;, # Required. Human readable title. Does not affect behavior.
127}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700128
129 x__xgafv: string, V1 error format.
130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
133
134Returns:
135 An object of the form:
136
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700137 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800138 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
139 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
140 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
141 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
142 {
143 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
144 },
145 ],
146 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
147 },
148 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
149 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
150 },
151 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
152 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
153 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
154 },
155}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700156</div>
157
158<div class="method">
159 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700160 <pre>Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700161
162Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700163 name: string, Required. Resource name for the access policy to delete. Format `accessPolicies/{policy_id}` (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700164 x__xgafv: string, V1 error format.
165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
168
169Returns:
170 An object of the form:
171
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700172 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800173 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
174 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
175 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
176 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
177 {
178 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
179 },
180 ],
181 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
182 },
183 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
184 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
185 },
186 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
187 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
188 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
189 },
190}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700191</div>
192
193<div class="method">
194 <code class="details" id="get">get(name, x__xgafv=None)</code>
195 <pre>Get an AccessPolicy by name.
196
197Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700198 name: string, Required. Resource name for the access policy to get. Format `accessPolicies/{policy_id}` (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700199 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
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700207 { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800208 &quot;etag&quot;: &quot;A String&quot;, # Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700209 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}`
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800210 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`
211 &quot;title&quot;: &quot;A String&quot;, # Required. Human readable title. Does not affect behavior.
212}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700213</div>
214
215<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800216 <code class="details" id="list">list(pageSize=None, pageToken=None, parent=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700217 <pre>List all AccessPolicies under a container.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700218
219Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700220 pageSize: integer, Number of AccessPolicy instances to include in the list. Default 100.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800221 pageToken: string, Next page token for the next batch of AccessPolicy instances. Defaults to the first page of results.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800222 parent: string, Required. Resource name for the container to list AccessPolicy instances from. Format: `organizations/{org_id}`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700223 x__xgafv: string, V1 error format.
224 Allowed values
225 1 - v1 error format
226 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700227
228Returns:
229 An object of the form:
230
231 { # A response to `ListAccessPoliciesRequest`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800232 &quot;accessPolicies&quot;: [ # List of the AccessPolicy instances.
233 { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization.
234 &quot;etag&quot;: &quot;A String&quot;, # Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700235 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}`
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800236 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`
237 &quot;title&quot;: &quot;A String&quot;, # Required. Human readable title. Does not affect behavior.
238 },
239 ],
240 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
241}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700242</div>
243
244<div class="method">
245 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
246 <pre>Retrieves the next page of results.
247
248Args:
249 previous_request: The request for the previous page. (required)
250 previous_response: The response from the request for the previous page. (required)
251
252Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700253 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700254 page. Returns None if there are no more items in the collection.
255 </pre>
256</div>
257
258<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700259 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700260 <pre>Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700261
262Args:
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700263 name: string, Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700264 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700265 The object takes the form of:
266
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700267{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800268 &quot;etag&quot;: &quot;A String&quot;, # Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700269 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}`
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800270 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`
271 &quot;title&quot;: &quot;A String&quot;, # Required. Human readable title. Does not affect behavior.
272}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700273
274 updateMask: string, Required. Mask to control which fields get updated. Must be non-empty.
275 x__xgafv: string, V1 error format.
276 Allowed values
277 1 - v1 error format
278 2 - v2 error format
279
280Returns:
281 An object of the form:
282
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700283 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800284 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
285 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
286 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
287 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
288 {
289 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
290 },
291 ],
292 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
293 },
294 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
295 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
296 },
297 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
298 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
299 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
300 },
301}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700302</div>
303
304</body></html>