Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / accesscontextmanager_v1beta.accessPolicies.servicePerimeters.html
blob: e37e5bea96e2ce850eb3099f7cf93a4b041f239a [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#list">list(parent, pageSize=None, pageToken=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
113 # import and export data amongst themselves, but not export outside of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 -
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]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.
122 "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 # restricted/unrestricted services and access levels that determine perimeter
124 # content and boundaries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]125 # describe specific Service Perimeter configuration.
126 "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
127 # restrictions. Must contain a list of services. For example, if
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 # `storage.googleapis.com` is specified, access to the storage buckets
129 # inside the perimeter must meet the perimeter's access restrictions.
130 "A String",
131 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]132 "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
133 # Perimeter.
134 "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
135 # APIs specified in 'allowed_services'.
136 "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
137 # unless 'enable_restriction' is True.
138 "A String",
139 ],
140 },
141 "unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 # restrictions. Deprecated. Must be set to a single wildcard "*".
143 #
144 # The wildcard means that unless explicitly specified by
145 # "restricted_services" list, any service is treated as unrestricted.
146 "A String",
147 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]148 "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 # Currently only projects are allowed. Format: `projects/{project_number}`
150 "A String",
151 ],
152 "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
153 # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
154 # must be in the same policy as this `ServicePerimeter`. Referencing a
155 # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]156 # listed, resources within the perimeter can only be accessed via Google
157 # Cloud calls with request origins within the perimeter. Example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158 # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
159 # For Service Perimeter Bridge, must be empty.
160 "A String",
161 ],
162 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 "title": "A String", # Human readable title. Must be unique within the Policy.
164 "perimeterType": "A String", # Perimeter type indicator. A single project is
165 # allowed to be a member of single regular perimeter, but multiple service
166 # perimeter bridges. A project cannot be a included in a perimeter bridge
167 # without being included in regular perimeter. For perimeter bridges,
168 # restricted/unrestricted service lists as well as access lists must be
169 # empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]170 "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
171 # component must begin with a letter and only include alphanumeric and '_'.
172 # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]173 "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
174 # behavior.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]175 }
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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]187 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL.
192 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193 "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.
194 # different programming environments, including REST APIs and RPC APIs. It is
195 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
196 # three pieces of data: error code, error message, and error details.
197 #
198 # You can find out more about this error model and how to work with it in the
199 # [API Design Guide](https://cloud.google.com/apis/design/errors).
200 "message": "A String", # A developer-facing error message, which should be in English. Any
201 # user-facing error message should be localized and sent in the
202 # google.rpc.Status.details field, or localized by the client.
203 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
204 "details": [ # A list of messages that carry the error details. There is a common set of
205 # message types for APIs to use.
206 {
207 "a_key": "", # Properties of the object. Contains field @type with type URL.
208 },
209 ],
210 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]211 "done": True or False, # If the value is `false`, it means the operation is still in progress.
212 # If `true`, the operation is completed, and either `error` or `response` is
213 # available.
214 "response": { # The normal response of the operation in case of success. If the original
215 # method returns no data on success, such as `Delete`, the response is
216 # `google.protobuf.Empty`. If the original method is standard
217 # `Get`/`Create`/`Update`, the response should be the resource. For other
218 # methods, the response should have the type `XxxResponse`, where `Xxx`
219 # is the original method name. For example, if the original method name
220 # is `TakeSnapshot()`, the inferred response type is
221 # `TakeSnapshotResponse`.
222 "a_key": "", # Properties of the object. Contains field @type with type URL.
223 },
224 "name": "A String", # The server-assigned name, which is only unique within the same service that
225 # originally returns it. If you use the default HTTP mapping, the
226 # `name` should be a resource name ending with `operations/{unique_id}`.
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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL.
257 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]258 "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.
259 # different programming environments, including REST APIs and RPC APIs. It is
260 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
261 # three pieces of data: error code, error message, and error details.
262 #
263 # You can find out more about this error model and how to work with it in the
264 # [API Design Guide](https://cloud.google.com/apis/design/errors).
265 "message": "A String", # A developer-facing error message, which should be in English. Any
266 # user-facing error message should be localized and sent in the
267 # google.rpc.Status.details field, or localized by the client.
268 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
269 "details": [ # A list of messages that carry the error details. There is a common set of
270 # message types for APIs to use.
271 {
272 "a_key": "", # Properties of the object. Contains field @type with type URL.
273 },
274 ],
275 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]276 "done": True or False, # If the value is `false`, it means the operation is still in progress.
277 # If `true`, the operation is completed, and either `error` or `response` is
278 # available.
279 "response": { # The normal response of the operation in case of success. If the original
280 # method returns no data on success, such as `Delete`, the response is
281 # `google.protobuf.Empty`. If the original method is standard
282 # `Get`/`Create`/`Update`, the response should be the resource. For other
283 # methods, the response should have the type `XxxResponse`, where `Xxx`
284 # is the original method name. For example, if the original method name
285 # is `TakeSnapshot()`, the inferred response type is
286 # `TakeSnapshotResponse`.
287 "a_key": "", # Properties of the object. Contains field @type with type URL.
288 },
289 "name": "A String", # The server-assigned name, which is only unique within the same service that
290 # originally returns it. If you use the default HTTP mapping, the
291 # `name` should be a resource name ending with `operations/{unique_id}`.
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
314 # import and export data amongst themselves, but not export outside of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 -
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]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.
323 "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324 # restricted/unrestricted services and access levels that determine perimeter
325 # content and boundaries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]326 # describe specific Service Perimeter configuration.
327 "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
328 # restrictions. Must contain a list of services. For example, if
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]329 # `storage.googleapis.com` is specified, access to the storage buckets
330 # inside the perimeter must meet the perimeter's access restrictions.
331 "A String",
332 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]333 "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
334 # Perimeter.
335 "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
336 # APIs specified in 'allowed_services'.
337 "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
338 # unless 'enable_restriction' is True.
339 "A String",
340 ],
341 },
342 "unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]343 # restrictions. Deprecated. Must be set to a single wildcard "*".
344 #
345 # The wildcard means that unless explicitly specified by
346 # "restricted_services" list, any service is treated as unrestricted.
347 "A String",
348 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]349 "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]350 # Currently only projects are allowed. Format: `projects/{project_number}`
351 "A String",
352 ],
353 "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
354 # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
355 # must be in the same policy as this `ServicePerimeter`. Referencing a
356 # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]357 # listed, resources within the perimeter can only be accessed via Google
358 # Cloud calls with request origins within the perimeter. Example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
360 # For Service Perimeter Bridge, must be empty.
361 "A String",
362 ],
363 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]364 "title": "A String", # Human readable title. Must be unique within the Policy.
365 "perimeterType": "A String", # Perimeter type indicator. A single project is
366 # allowed to be a member of single regular perimeter, but multiple service
367 # perimeter bridges. A project cannot be a included in a perimeter bridge
368 # without being included in regular perimeter. For perimeter bridges,
369 # restricted/unrestricted service lists as well as access lists must be
370 # empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]371 "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
372 # component must begin with a letter and only include alphanumeric and '_'.
373 # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]374 "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
375 # behavior.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]376 }</pre>
377</div>
378
379<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]380 <code class="details" id="list">list(parent, pageSize=None, pageToken=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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]389 pageSize: integer, Number of Service Perimeters to include
390in the list. Default 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]391 pageToken: string, Next page token for the next batch of Service Perimeter instances.
392Defaults to the first page of results.
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`.
402 "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
403 # empty, no further results remain.
404 "servicePerimeters": [ # List of the Service Perimeter instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]405 { # `ServicePerimeter` describes a set of Google Cloud resources which can freely
406 # import and export data amongst themselves, but not export outside of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]407 # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
408 # has a target outside of the `ServicePerimeter`, the request will be blocked.
409 # Otherwise the request is allowed. There are two types of Service Perimeter -
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]410 # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
411 # Google Cloud project can only belong to a single regular Service Perimeter.
412 # Service Perimeter Bridges can contain only Google Cloud projects as members,
413 # a single Google Cloud project may belong to multiple Service Perimeter
414 # Bridges.
415 "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]416 # restricted/unrestricted services and access levels that determine perimeter
417 # content and boundaries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]418 # describe specific Service Perimeter configuration.
419 "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
420 # restrictions. Must contain a list of services. For example, if
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]421 # `storage.googleapis.com` is specified, access to the storage buckets
422 # inside the perimeter must meet the perimeter's access restrictions.
423 "A String",
424 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]425 "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
426 # Perimeter.
427 "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
428 # APIs specified in 'allowed_services'.
429 "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
430 # unless 'enable_restriction' is True.
431 "A String",
432 ],
433 },
434 "unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]435 # restrictions. Deprecated. Must be set to a single wildcard "*".
436 #
437 # The wildcard means that unless explicitly specified by
438 # "restricted_services" list, any service is treated as unrestricted.
439 "A String",
440 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]441 "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]442 # Currently only projects are allowed. Format: `projects/{project_number}`
443 "A String",
444 ],
445 "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
446 # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
447 # must be in the same policy as this `ServicePerimeter`. Referencing a
448 # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]449 # listed, resources within the perimeter can only be accessed via Google
450 # Cloud calls with request origins within the perimeter. Example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]451 # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
452 # For Service Perimeter Bridge, must be empty.
453 "A String",
454 ],
455 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]456 "title": "A String", # Human readable title. Must be unique within the Policy.
457 "perimeterType": "A String", # Perimeter type indicator. A single project is
458 # allowed to be a member of single regular perimeter, but multiple service
459 # perimeter bridges. A project cannot be a included in a perimeter bridge
460 # without being included in regular perimeter. For perimeter bridges,
461 # restricted/unrestricted service lists as well as access lists must be
462 # empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]463 "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
464 # component must begin with a letter and only include alphanumeric and '_'.
465 # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]466 "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
467 # behavior.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]468 },
469 ],
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:
482 A request object that you can call 'execute()' on to request the next
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`
497component must begin with a letter and only include alphanumeric and '_'.
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
503 # import and export data amongst themselves, but not export outside of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 -
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]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.
512 "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]513 # restricted/unrestricted services and access levels that determine perimeter
514 # content and boundaries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]515 # describe specific Service Perimeter configuration.
516 "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
517 # restrictions. Must contain a list of services. For example, if
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]518 # `storage.googleapis.com` is specified, access to the storage buckets
519 # inside the perimeter must meet the perimeter's access restrictions.
520 "A String",
521 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]522 "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
523 # Perimeter.
524 "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
525 # APIs specified in 'allowed_services'.
526 "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
527 # unless 'enable_restriction' is True.
528 "A String",
529 ],
530 },
531 "unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]532 # restrictions. Deprecated. Must be set to a single wildcard "*".
533 #
534 # The wildcard means that unless explicitly specified by
535 # "restricted_services" list, any service is treated as unrestricted.
536 "A String",
537 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]538 "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]539 # Currently only projects are allowed. Format: `projects/{project_number}`
540 "A String",
541 ],
542 "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
543 # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
544 # must be in the same policy as this `ServicePerimeter`. Referencing a
545 # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]546 # listed, resources within the perimeter can only be accessed via Google
547 # Cloud calls with request origins within the perimeter. Example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]548 # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
549 # For Service Perimeter Bridge, must be empty.
550 "A String",
551 ],
552 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]553 "title": "A String", # Human readable title. Must be unique within the Policy.
554 "perimeterType": "A String", # Perimeter type indicator. A single project is
555 # allowed to be a member of single regular perimeter, but multiple service
556 # perimeter bridges. A project cannot be a included in a perimeter bridge
557 # without being included in regular perimeter. For perimeter bridges,
558 # restricted/unrestricted service lists as well as access lists must be
559 # empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]560 "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
561 # component must begin with a letter and only include alphanumeric and '_'.
562 # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]563 "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
564 # behavior.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]565 }
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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]578 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL.
583 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]584 "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.
585 # different programming environments, including REST APIs and RPC APIs. It is
586 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
587 # three pieces of data: error code, error message, and error details.
588 #
589 # You can find out more about this error model and how to work with it in the
590 # [API Design Guide](https://cloud.google.com/apis/design/errors).
591 "message": "A String", # A developer-facing error message, which should be in English. Any
592 # user-facing error message should be localized and sent in the
593 # google.rpc.Status.details field, or localized by the client.
594 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
595 "details": [ # A list of messages that carry the error details. There is a common set of
596 # message types for APIs to use.
597 {
598 "a_key": "", # Properties of the object. Contains field @type with type URL.
599 },
600 ],
601 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]602 "done": True or False, # If the value is `false`, it means the operation is still in progress.
603 # If `true`, the operation is completed, and either `error` or `response` is
604 # available.
605 "response": { # The normal response of the operation in case of success. If the original
606 # method returns no data on success, such as `Delete`, the response is
607 # `google.protobuf.Empty`. If the original method is standard
608 # `Get`/`Create`/`Update`, the response should be the resource. For other
609 # methods, the response should have the type `XxxResponse`, where `Xxx`
610 # is the original method name. For example, if the original method name
611 # is `TakeSnapshot()`, the inferred response type is
612 # `TakeSnapshotResponse`.
613 "a_key": "", # Properties of the object. Contains field @type with type URL.
614 },
615 "name": "A String", # The server-assigned name, which is only unique within the same service that
616 # originally returns it. If you use the default HTTP mapping, the
617 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]618 }</pre>
619</div>
620
621</body></html>