Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / accesscontextmanager_v1beta.accessPolicies.servicePerimeters.html
blob: 5e435a9e137aa59df0b49507b7db7c741805849d [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> . <a href="accesscontextmanager_v1beta.accessPolicies.servicePerimeters.html">servicePerimeters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Create a Service Perimeter. The</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]82<p class="firstline">Delete a Service Perimeter by resource</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]85<p class="firstline">Get a Service Perimeter by resource</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">List all Service Perimeters for an</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Update a Service Perimeter. The</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
98 <pre>Create a Service Perimeter. The
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99longrunning operation from this RPC will have a successful status once the
100Service Perimeter has
101propagated to long-lasting storage. Service Perimeters containing
102errors will result in an error response for the first error encountered.
103
104Args:
105 parent: string, Required. Resource name for the access policy which owns this Service
106Perimeter.
107
108Format: `accessPolicies/{policy_id}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]109 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 The object takes the form of:
111
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]112{ # `ServicePerimeter` describes a set of Google Cloud resources which can freely
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]113 # import and export data amongst themselves, but not export outside of the
114 # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
115 # has a target outside of the `ServicePerimeter`, the request will be blocked.
116 # Otherwise the request is allowed. There are two types of Service Perimeter -
117 # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
118 # Google Cloud project can only belong to a single regular Service Perimeter.
119 # Service Perimeter Bridges can contain only Google Cloud projects as members,
120 # a single Google Cloud project may belong to multiple Service Perimeter
121 # Bridges.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]122 &quot;status&quot;: { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
123 # restricted/unrestricted services and access levels that determine perimeter
124 # content and boundaries.
125 # describe specific Service Perimeter configuration.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]126 &quot;unrestrictedServices&quot;: [ # Google Cloud services that are not subject to the Service Perimeter
127 # restrictions. Deprecated. Must be set to a single wildcard &quot;*&quot;.
128 #
129 # The wildcard means that unless explicitly specified by
130 # &quot;restricted_services&quot; list, any service is treated as unrestricted.
131 &quot;A String&quot;,
132 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]133 &quot;accessLevels&quot;: [ # A list of `AccessLevel` resource names that allow resources within the
134 # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
135 # must be in the same policy as this `ServicePerimeter`. Referencing a
136 # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
137 # listed, resources within the perimeter can only be accessed via Google
138 # Cloud calls with request origins within the perimeter. Example:
139 # `&quot;accessPolicies/MY_POLICY/accessLevels/MY_LEVEL&quot;`.
140 # For Service Perimeter Bridge, must be empty.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]143 &quot;resources&quot;: [ # A list of Google Cloud resources that are inside of the service perimeter.
144 # Currently only projects are allowed. Format: `projects/{project_number}`
145 &quot;A String&quot;,
146 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]147 &quot;restrictedServices&quot;: [ # Google Cloud services that are subject to the Service Perimeter
148 # restrictions. Must contain a list of services. For example, if
149 # `storage.googleapis.com` is specified, access to the storage buckets
150 # inside the perimeter must meet the perimeter&#x27;s access restrictions.
151 &quot;A String&quot;,
152 ],
153 &quot;vpcAccessibleServices&quot;: { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
154 # Perimeter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]155 &quot;allowedServices&quot;: [ # The list of APIs usable within the Service Perimeter. Must be empty
156 # unless &#x27;enable_restriction&#x27; is True.
157 &quot;A String&quot;,
158 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]159 &quot;enableRestriction&quot;: True or False, # Whether to restrict API calls within the Service Perimeter to the list of
160 # APIs specified in &#x27;allowed_services&#x27;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]161 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]163 &quot;perimeterType&quot;: &quot;A String&quot;, # Perimeter type indicator. A single project is
164 # allowed to be a member of single regular perimeter, but multiple service
165 # perimeter bridges. A project cannot be a included in a perimeter bridge
166 # without being included in regular perimeter. For perimeter bridges,
167 # restricted/unrestricted service lists as well as access lists must be
168 # empty.
169 &quot;title&quot;: &quot;A String&quot;, # Human readable title. Must be unique within the Policy.
170 &quot;description&quot;: &quot;A String&quot;, # Description of the `ServicePerimeter` and its use. Does not affect
171 # behavior.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]172 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for the ServicePerimeter. The `short_name`
173 # component must begin with a letter and only include alphanumeric and &#x27;_&#x27;.
174 # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]175 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176
177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
181
182Returns:
183 An object of the form:
184
185 { # This resource represents a long-running operation that is the result of a
186 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
188 # contains progress information and common metadata such as create time.
189 # Some services might not provide such metadata. Any method that returns a
190 # long-running operation should document the metadata type, if any.
191 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
192 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]193 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
194 # method returns no data on success, such as `Delete`, the response is
195 # `google.protobuf.Empty`. If the original method is standard
196 # `Get`/`Create`/`Update`, the response should be the resource. For other
197 # methods, the response should have the type `XxxResponse`, where `Xxx`
198 # is the original method name. For example, if the original method name
199 # is `TakeSnapshot()`, the inferred response type is
200 # `TakeSnapshotResponse`.
201 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
202 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]203 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
204 # originally returns it. If you use the default HTTP mapping, the
205 # `name` should be a resource name ending with `operations/{unique_id}`.
206 &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.
207 # different programming environments, including REST APIs and RPC APIs. It is
208 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
209 # three pieces of data: error code, error message, and error details.
210 #
211 # You can find out more about this error model and how to work with it in the
212 # [API Design Guide](https://cloud.google.com/apis/design/errors).
213 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
214 # user-facing error message should be localized and sent in the
215 # google.rpc.Status.details field, or localized by the client.
216 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
217 # message types for APIs to use.
218 {
219 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
220 },
221 ],
222 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
223 },
224 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
225 # If `true`, the operation is completed, and either `error` or `response` is
226 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]227 }</pre>
228</div>
229
230<div class="method">
231 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]232 <pre>Delete a Service Perimeter by resource
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]233name. The longrunning operation from this RPC will have a successful status
234once the Service Perimeter has been
235removed from long-lasting storage.
236
237Args:
238 name: string, Required. Resource name for the Service Perimeter.
239
240Format:
241`accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}` (required)
242 x__xgafv: string, V1 error format.
243 Allowed values
244 1 - v1 error format
245 2 - v2 error format
246
247Returns:
248 An object of the form:
249
250 { # This resource represents a long-running operation that is the result of a
251 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]252 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
253 # contains progress information and common metadata such as create time.
254 # Some services might not provide such metadata. Any method that returns a
255 # long-running operation should document the metadata type, if any.
256 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
257 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]258 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
259 # method returns no data on success, such as `Delete`, the response is
260 # `google.protobuf.Empty`. If the original method is standard
261 # `Get`/`Create`/`Update`, the response should be the resource. For other
262 # methods, the response should have the type `XxxResponse`, where `Xxx`
263 # is the original method name. For example, if the original method name
264 # is `TakeSnapshot()`, the inferred response type is
265 # `TakeSnapshotResponse`.
266 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
267 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]268 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
269 # originally returns it. If you use the default HTTP mapping, the
270 # `name` should be a resource name ending with `operations/{unique_id}`.
271 &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.
272 # different programming environments, including REST APIs and RPC APIs. It is
273 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
274 # three pieces of data: error code, error message, and error details.
275 #
276 # You can find out more about this error model and how to work with it in the
277 # [API Design Guide](https://cloud.google.com/apis/design/errors).
278 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
279 # user-facing error message should be localized and sent in the
280 # google.rpc.Status.details field, or localized by the client.
281 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
282 # message types for APIs to use.
283 {
284 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
285 },
286 ],
287 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
288 },
289 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
290 # If `true`, the operation is completed, and either `error` or `response` is
291 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]292 }</pre>
293</div>
294
295<div class="method">
296 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]297 <pre>Get a Service Perimeter by resource
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]298name.
299
300Args:
301 name: string, Required. Resource name for the Service Perimeter.
302
303Format:
304`accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}` (required)
305 x__xgafv: string, V1 error format.
306 Allowed values
307 1 - v1 error format
308 2 - v2 error format
309
310Returns:
311 An object of the form:
312
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]313 { # `ServicePerimeter` describes a set of Google Cloud resources which can freely
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]314 # import and export data amongst themselves, but not export outside of the
315 # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
316 # has a target outside of the `ServicePerimeter`, the request will be blocked.
317 # Otherwise the request is allowed. There are two types of Service Perimeter -
318 # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
319 # Google Cloud project can only belong to a single regular Service Perimeter.
320 # Service Perimeter Bridges can contain only Google Cloud projects as members,
321 # a single Google Cloud project may belong to multiple Service Perimeter
322 # Bridges.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]323 &quot;status&quot;: { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
324 # restricted/unrestricted services and access levels that determine perimeter
325 # content and boundaries.
326 # describe specific Service Perimeter configuration.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]327 &quot;unrestrictedServices&quot;: [ # Google Cloud services that are not subject to the Service Perimeter
328 # restrictions. Deprecated. Must be set to a single wildcard &quot;*&quot;.
329 #
330 # The wildcard means that unless explicitly specified by
331 # &quot;restricted_services&quot; list, any service is treated as unrestricted.
332 &quot;A String&quot;,
333 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]334 &quot;accessLevels&quot;: [ # A list of `AccessLevel` resource names that allow resources within the
335 # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
336 # must be in the same policy as this `ServicePerimeter`. Referencing a
337 # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
338 # listed, resources within the perimeter can only be accessed via Google
339 # Cloud calls with request origins within the perimeter. Example:
340 # `&quot;accessPolicies/MY_POLICY/accessLevels/MY_LEVEL&quot;`.
341 # For Service Perimeter Bridge, must be empty.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]342 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]343 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]344 &quot;resources&quot;: [ # A list of Google Cloud resources that are inside of the service perimeter.
345 # Currently only projects are allowed. Format: `projects/{project_number}`
346 &quot;A String&quot;,
347 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]348 &quot;restrictedServices&quot;: [ # Google Cloud services that are subject to the Service Perimeter
349 # restrictions. Must contain a list of services. For example, if
350 # `storage.googleapis.com` is specified, access to the storage buckets
351 # inside the perimeter must meet the perimeter&#x27;s access restrictions.
352 &quot;A String&quot;,
353 ],
354 &quot;vpcAccessibleServices&quot;: { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
355 # Perimeter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]356 &quot;allowedServices&quot;: [ # The list of APIs usable within the Service Perimeter. Must be empty
357 # unless &#x27;enable_restriction&#x27; is True.
358 &quot;A String&quot;,
359 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]360 &quot;enableRestriction&quot;: True or False, # Whether to restrict API calls within the Service Perimeter to the list of
361 # APIs specified in &#x27;allowed_services&#x27;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]362 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]363 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]364 &quot;perimeterType&quot;: &quot;A String&quot;, # Perimeter type indicator. A single project is
365 # allowed to be a member of single regular perimeter, but multiple service
366 # perimeter bridges. A project cannot be a included in a perimeter bridge
367 # without being included in regular perimeter. For perimeter bridges,
368 # restricted/unrestricted service lists as well as access lists must be
369 # empty.
370 &quot;title&quot;: &quot;A String&quot;, # Human readable title. Must be unique within the Policy.
371 &quot;description&quot;: &quot;A String&quot;, # Description of the `ServicePerimeter` and its use. Does not affect
372 # behavior.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]373 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for the ServicePerimeter. The `short_name`
374 # component must begin with a letter and only include alphanumeric and &#x27;_&#x27;.
375 # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]376 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]377</div>
378
379<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]380 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]381 <pre>List all Service Perimeters for an
382access policy.
383
384Args:
385 parent: string, Required. Resource name for the access policy to list Service Perimeters from.
386
387Format:
388`accessPolicies/{policy_id}` (required)
389 pageToken: string, Next page token for the next batch of Service Perimeter instances.
390Defaults to the first page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]391 pageSize: integer, Number of Service Perimeters to include
392in the list. Default 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]393 x__xgafv: string, V1 error format.
394 Allowed values
395 1 - v1 error format
396 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]397
398Returns:
399 An object of the form:
400
401 { # A response to `ListServicePerimetersRequest`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]402 &quot;servicePerimeters&quot;: [ # List of the Service Perimeter instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]403 { # `ServicePerimeter` describes a set of Google Cloud resources which can freely
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]404 # import and export data amongst themselves, but not export outside of the
405 # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
406 # has a target outside of the `ServicePerimeter`, the request will be blocked.
407 # Otherwise the request is allowed. There are two types of Service Perimeter -
408 # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
409 # Google Cloud project can only belong to a single regular Service Perimeter.
410 # Service Perimeter Bridges can contain only Google Cloud projects as members,
411 # a single Google Cloud project may belong to multiple Service Perimeter
412 # Bridges.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]413 &quot;status&quot;: { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
414 # restricted/unrestricted services and access levels that determine perimeter
415 # content and boundaries.
416 # describe specific Service Perimeter configuration.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]417 &quot;unrestrictedServices&quot;: [ # Google Cloud services that are not subject to the Service Perimeter
418 # restrictions. Deprecated. Must be set to a single wildcard &quot;*&quot;.
419 #
420 # The wildcard means that unless explicitly specified by
421 # &quot;restricted_services&quot; list, any service is treated as unrestricted.
422 &quot;A String&quot;,
423 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]424 &quot;accessLevels&quot;: [ # A list of `AccessLevel` resource names that allow resources within the
425 # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
426 # must be in the same policy as this `ServicePerimeter`. Referencing a
427 # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
428 # listed, resources within the perimeter can only be accessed via Google
429 # Cloud calls with request origins within the perimeter. Example:
430 # `&quot;accessPolicies/MY_POLICY/accessLevels/MY_LEVEL&quot;`.
431 # For Service Perimeter Bridge, must be empty.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]432 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]433 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]434 &quot;resources&quot;: [ # A list of Google Cloud resources that are inside of the service perimeter.
435 # Currently only projects are allowed. Format: `projects/{project_number}`
436 &quot;A String&quot;,
437 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]438 &quot;restrictedServices&quot;: [ # Google Cloud services that are subject to the Service Perimeter
439 # restrictions. Must contain a list of services. For example, if
440 # `storage.googleapis.com` is specified, access to the storage buckets
441 # inside the perimeter must meet the perimeter&#x27;s access restrictions.
442 &quot;A String&quot;,
443 ],
444 &quot;vpcAccessibleServices&quot;: { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
445 # Perimeter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]446 &quot;allowedServices&quot;: [ # The list of APIs usable within the Service Perimeter. Must be empty
447 # unless &#x27;enable_restriction&#x27; is True.
448 &quot;A String&quot;,
449 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]450 &quot;enableRestriction&quot;: True or False, # Whether to restrict API calls within the Service Perimeter to the list of
451 # APIs specified in &#x27;allowed_services&#x27;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]452 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]453 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]454 &quot;perimeterType&quot;: &quot;A String&quot;, # Perimeter type indicator. A single project is
455 # allowed to be a member of single regular perimeter, but multiple service
456 # perimeter bridges. A project cannot be a included in a perimeter bridge
457 # without being included in regular perimeter. For perimeter bridges,
458 # restricted/unrestricted service lists as well as access lists must be
459 # empty.
460 &quot;title&quot;: &quot;A String&quot;, # Human readable title. Must be unique within the Policy.
461 &quot;description&quot;: &quot;A String&quot;, # Description of the `ServicePerimeter` and its use. Does not affect
462 # behavior.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]463 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for the ServicePerimeter. The `short_name`
464 # component must begin with a letter and only include alphanumeric and &#x27;_&#x27;.
465 # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]466 },
467 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]468 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token to retrieve the next page of results. If the value is
469 # empty, no further results remain.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]470 }</pre>
471</div>
472
473<div class="method">
474 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
475 <pre>Retrieves the next page of results.
476
477Args:
478 previous_request: The request for the previous page. (required)
479 previous_response: The response from the request for the previous page. (required)
480
481Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]482 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]483 page. Returns None if there are no more items in the collection.
484 </pre>
485</div>
486
487<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]488 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
489 <pre>Update a Service Perimeter. The
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]490longrunning operation from this RPC will have a successful status once the
491changes to the Service Perimeter have
492propagated to long-lasting storage. Service Perimeter containing
493errors will result in an error response for the first error encountered.
494
495Args:
496 name: string, Required. Resource name for the ServicePerimeter. The `short_name`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]497component must begin with a letter and only include alphanumeric and &#x27;_&#x27;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]498Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]499 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]500 The object takes the form of:
501
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]502{ # `ServicePerimeter` describes a set of Google Cloud resources which can freely
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]503 # import and export data amongst themselves, but not export outside of the
504 # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
505 # has a target outside of the `ServicePerimeter`, the request will be blocked.
506 # Otherwise the request is allowed. There are two types of Service Perimeter -
507 # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
508 # Google Cloud project can only belong to a single regular Service Perimeter.
509 # Service Perimeter Bridges can contain only Google Cloud projects as members,
510 # a single Google Cloud project may belong to multiple Service Perimeter
511 # Bridges.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]512 &quot;status&quot;: { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
513 # restricted/unrestricted services and access levels that determine perimeter
514 # content and boundaries.
515 # describe specific Service Perimeter configuration.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]516 &quot;unrestrictedServices&quot;: [ # Google Cloud services that are not subject to the Service Perimeter
517 # restrictions. Deprecated. Must be set to a single wildcard &quot;*&quot;.
518 #
519 # The wildcard means that unless explicitly specified by
520 # &quot;restricted_services&quot; list, any service is treated as unrestricted.
521 &quot;A String&quot;,
522 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]523 &quot;accessLevels&quot;: [ # A list of `AccessLevel` resource names that allow resources within the
524 # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
525 # must be in the same policy as this `ServicePerimeter`. Referencing a
526 # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
527 # listed, resources within the perimeter can only be accessed via Google
528 # Cloud calls with request origins within the perimeter. Example:
529 # `&quot;accessPolicies/MY_POLICY/accessLevels/MY_LEVEL&quot;`.
530 # For Service Perimeter Bridge, must be empty.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]531 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]532 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]533 &quot;resources&quot;: [ # A list of Google Cloud resources that are inside of the service perimeter.
534 # Currently only projects are allowed. Format: `projects/{project_number}`
535 &quot;A String&quot;,
536 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]537 &quot;restrictedServices&quot;: [ # Google Cloud services that are subject to the Service Perimeter
538 # restrictions. Must contain a list of services. For example, if
539 # `storage.googleapis.com` is specified, access to the storage buckets
540 # inside the perimeter must meet the perimeter&#x27;s access restrictions.
541 &quot;A String&quot;,
542 ],
543 &quot;vpcAccessibleServices&quot;: { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
544 # Perimeter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]545 &quot;allowedServices&quot;: [ # The list of APIs usable within the Service Perimeter. Must be empty
546 # unless &#x27;enable_restriction&#x27; is True.
547 &quot;A String&quot;,
548 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]549 &quot;enableRestriction&quot;: True or False, # Whether to restrict API calls within the Service Perimeter to the list of
550 # APIs specified in &#x27;allowed_services&#x27;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]551 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]552 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]553 &quot;perimeterType&quot;: &quot;A String&quot;, # Perimeter type indicator. A single project is
554 # allowed to be a member of single regular perimeter, but multiple service
555 # perimeter bridges. A project cannot be a included in a perimeter bridge
556 # without being included in regular perimeter. For perimeter bridges,
557 # restricted/unrestricted service lists as well as access lists must be
558 # empty.
559 &quot;title&quot;: &quot;A String&quot;, # Human readable title. Must be unique within the Policy.
560 &quot;description&quot;: &quot;A String&quot;, # Description of the `ServicePerimeter` and its use. Does not affect
561 # behavior.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]562 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for the ServicePerimeter. The `short_name`
563 # component must begin with a letter and only include alphanumeric and &#x27;_&#x27;.
564 # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]565 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]566
567 updateMask: string, Required. Mask to control which fields get updated. Must be non-empty.
568 x__xgafv: string, V1 error format.
569 Allowed values
570 1 - v1 error format
571 2 - v2 error format
572
573Returns:
574 An object of the form:
575
576 { # This resource represents a long-running operation that is the result of a
577 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]578 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
579 # contains progress information and common metadata such as create time.
580 # Some services might not provide such metadata. Any method that returns a
581 # long-running operation should document the metadata type, if any.
582 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
583 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]584 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
585 # method returns no data on success, such as `Delete`, the response is
586 # `google.protobuf.Empty`. If the original method is standard
587 # `Get`/`Create`/`Update`, the response should be the resource. For other
588 # methods, the response should have the type `XxxResponse`, where `Xxx`
589 # is the original method name. For example, if the original method name
590 # is `TakeSnapshot()`, the inferred response type is
591 # `TakeSnapshotResponse`.
592 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
593 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]594 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
595 # originally returns it. If you use the default HTTP mapping, the
596 # `name` should be a resource name ending with `operations/{unique_id}`.
597 &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.
598 # different programming environments, including REST APIs and RPC APIs. It is
599 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
600 # three pieces of data: error code, error message, and error details.
601 #
602 # You can find out more about this error model and how to work with it in the
603 # [API Design Guide](https://cloud.google.com/apis/design/errors).
604 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
605 # user-facing error message should be localized and sent in the
606 # google.rpc.Status.details field, or localized by the client.
607 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
608 # message types for APIs to use.
609 {
610 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
611 },
612 ],
613 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
614 },
615 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
616 # If `true`, the operation is completed, and either `error` or `response` is
617 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]618 }</pre>
619</div>
620
621</body></html>