| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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> . <a href="accesscontextmanager_v1.accessPolicies.servicePerimeters.html">servicePerimeters</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#commit">commit(parent, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Commit the dry-run spec for all the Service Perimeters in an</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Create a Service Perimeter. The</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 85 | <p class="firstline">Delete a Service Perimeter by resource</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 88 | <p class="firstline">Get a Service Perimeter by resource</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 89 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 90 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">List all Service Perimeters for an</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Update a Service Perimeter. The</p> |
| 98 | <p class="toc_element"> |
| 99 | <code><a href="#replaceAll">replaceAll(parent, body=None, x__xgafv=None)</a></code></p> |
| 100 | <p class="firstline">Replace all existing Service Perimeters in an</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 101 | <h3>Method Details</h3> |
| 102 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 103 | <code class="details" id="commit">commit(parent, body=None, x__xgafv=None)</code> |
| 104 | <pre>Commit the dry-run spec for all the Service Perimeters in an |
| 105 | Access Policy. |
| 106 | A commit operation on a Service Perimeter involves copying its `spec` field |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 107 | to that Service Perimeter's `status` field. Only Service Perimeters with |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 108 | `use_explicit_dry_run_spec` field set to true are affected by a commit |
| 109 | operation. The longrunning operation from this RPC will have a successful |
| 110 | status once the dry-run specs for all the Service Perimeters have been |
| 111 | committed. If a commit fails, it will cause the longrunning operation to |
| 112 | return an error response and the entire commit operation will be cancelled. |
| 113 | When successful, Operation.response field will contain |
| 114 | CommitServicePerimetersResponse. The `dry_run` and the `spec` fields will |
| 115 | be cleared after a successful commit operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 116 | |
| 117 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 118 | parent: string, Required. Resource name for the parent Access Policy which owns all |
| 119 | Service Perimeters in scope for |
| 120 | the commit operation. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 121 | |
| 122 | Format: `accessPolicies/{policy_id}` (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 123 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 124 | The object takes the form of: |
| 125 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 126 | { # A request to commit dry-run specs in all Service Perimeters belonging to |
| 127 | # an Access Policy. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 128 | "etag": "A String", # Optional. The etag for the version of the Access Policy that this |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 129 | # commit operation is to be performed on. If, at the time of commit, the |
| 130 | # etag for the Access Policy stored in Access Context Manager is different |
| 131 | # from the specified etag, then the commit operation will not be performed |
| 132 | # and the call will fail. This field is not required. If etag is not |
| 133 | # provided, the operation will be performed as if a valid etag is provided. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 134 | } |
| 135 | |
| 136 | x__xgafv: string, V1 error format. |
| 137 | Allowed values |
| 138 | 1 - v1 error format |
| 139 | 2 - v2 error format |
| 140 | |
| 141 | Returns: |
| 142 | An object of the form: |
| 143 | |
| 144 | { # This resource represents a long-running operation that is the result of a |
| 145 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 146 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 147 | # originally returns it. If you use the default HTTP mapping, the |
| 148 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 149 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 150 | # contains progress information and common metadata such as create time. |
| 151 | # Some services might not provide such metadata. Any method that returns a |
| 152 | # long-running operation should document the metadata type, if any. |
| 153 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 154 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 155 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 156 | # method returns no data on success, such as `Delete`, the response is |
| 157 | # `google.protobuf.Empty`. If the original method is standard |
| 158 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 159 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 160 | # is the original method name. For example, if the original method name |
| 161 | # is `TakeSnapshot()`, the inferred response type is |
| 162 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 163 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 164 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 165 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 166 | # If `true`, the operation is completed, and either `error` or `response` is |
| 167 | # available. |
| 168 | "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. |
| 169 | # different programming environments, including REST APIs and RPC APIs. It is |
| 170 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 171 | # three pieces of data: error code, error message, and error details. |
| 172 | # |
| 173 | # You can find out more about this error model and how to work with it in the |
| 174 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 175 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 176 | # message types for APIs to use. |
| 177 | { |
| 178 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 179 | }, |
| 180 | ], |
| 181 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 182 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 183 | # user-facing error message should be localized and sent in the |
| 184 | # google.rpc.Status.details field, or localized by the client. |
| 185 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 186 | }</pre> |
| 187 | </div> |
| 188 | |
| 189 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 190 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 191 | <pre>Create a Service Perimeter. The |
| 192 | longrunning operation from this RPC will have a successful status once the |
| 193 | Service Perimeter has |
| 194 | propagated to long-lasting storage. Service Perimeters containing |
| 195 | errors will result in an error response for the first error encountered. |
| 196 | |
| 197 | Args: |
| 198 | parent: string, Required. Resource name for the access policy which owns this Service |
| 199 | Perimeter. |
| 200 | |
| 201 | Format: `accessPolicies/{policy_id}` (required) |
| 202 | body: object, The request body. |
| 203 | The object takes the form of: |
| 204 | |
| 205 | { # `ServicePerimeter` describes a set of Google Cloud resources which can freely |
| 206 | # import and export data amongst themselves, but not export outside of the |
| 207 | # `ServicePerimeter`. If a request with a source within this `ServicePerimeter` |
| 208 | # has a target outside of the `ServicePerimeter`, the request will be blocked. |
| 209 | # Otherwise the request is allowed. There are two types of Service Perimeter - |
| 210 | # Regular and Bridge. Regular Service Perimeters cannot overlap, a single |
| 211 | # Google Cloud project can only belong to a single regular Service Perimeter. |
| 212 | # Service Perimeter Bridges can contain only Google Cloud projects as members, |
| 213 | # a single Google Cloud project may belong to multiple Service Perimeter |
| 214 | # Bridges. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 215 | "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect |
| 216 | # behavior. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 217 | "perimeterType": "A String", # Perimeter type indicator. A single project is |
| 218 | # allowed to be a member of single regular perimeter, but multiple service |
| 219 | # perimeter bridges. A project cannot be a included in a perimeter bridge |
| 220 | # without being included in regular perimeter. For perimeter bridges, |
| 221 | # the restricted service list as well as access level lists must be |
| 222 | # empty. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 223 | "useExplicitDryRunSpec": True or False, # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly |
| 224 | # exists for all Service Perimeters, and that spec is identical to the |
| 225 | # status for those Service Perimeters. When this flag is set, it inhibits the |
| 226 | # generation of the implicit spec, thereby allowing the user to explicitly |
| 227 | # provide a configuration ("spec") to use in a dry-run version of the Service |
| 228 | # Perimeter. This allows the user to test changes to the enforced config |
| 229 | # ("status") without actually enforcing them. This testing is done through |
| 230 | # analyzing the differences between currently enforced and suggested |
| 231 | # restrictions. use_explicit_dry_run_spec must bet set to True if any of the |
| 232 | # fields in the spec are set to non-default values. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 233 | "title": "A String", # Human readable title. Must be unique within the Policy. |
| 234 | "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name` |
| 235 | # component must begin with a letter and only include alphanumeric and '_'. |
| 236 | # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 237 | "spec": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Proposed (or dry run) ServicePerimeter configuration. This configuration |
| 238 | # allows to specify and test ServicePerimeter configuration without enforcing |
| 239 | # actual access restrictions. Only allowed to be set when the |
| 240 | # "use_explicit_dry_run_spec" flag is set. |
| 241 | # describe specific Service Perimeter configuration. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 242 | "resources": [ # A list of Google Cloud resources that are inside of the service perimeter. |
| 243 | # Currently only projects are allowed. Format: `projects/{project_number}` |
| 244 | "A String", |
| 245 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 246 | "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter. |
| 247 | # Perimeter. |
| 248 | "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of |
| 249 | # APIs specified in 'allowed_services'. |
| 250 | "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty |
| 251 | # unless 'enable_restriction' is True. |
| 252 | "A String", |
| 253 | ], |
| 254 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 255 | "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the |
| 256 | # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed |
| 257 | # must be in the same policy as this `ServicePerimeter`. Referencing a |
| 258 | # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are |
| 259 | # listed, resources within the perimeter can only be accessed via Google |
| 260 | # Cloud calls with request origins within the perimeter. Example: |
| 261 | # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. |
| 262 | # For Service Perimeter Bridge, must be empty. |
| 263 | "A String", |
| 264 | ], |
| 265 | "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter |
| 266 | # restrictions. For example, if `storage.googleapis.com` is specified, access |
| 267 | # to the storage buckets inside the perimeter must meet the perimeter's |
| 268 | # access restrictions. |
| 269 | "A String", |
| 270 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 271 | }, |
| 272 | "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources, |
| 273 | # restricted services and access levels that determine perimeter |
| 274 | # content and boundaries. |
| 275 | # describe specific Service Perimeter configuration. |
| 276 | "resources": [ # A list of Google Cloud resources that are inside of the service perimeter. |
| 277 | # Currently only projects are allowed. Format: `projects/{project_number}` |
| 278 | "A String", |
| 279 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 280 | "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter. |
| 281 | # Perimeter. |
| 282 | "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of |
| 283 | # APIs specified in 'allowed_services'. |
| 284 | "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty |
| 285 | # unless 'enable_restriction' is True. |
| 286 | "A String", |
| 287 | ], |
| 288 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 289 | "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the |
| 290 | # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed |
| 291 | # must be in the same policy as this `ServicePerimeter`. Referencing a |
| 292 | # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are |
| 293 | # listed, resources within the perimeter can only be accessed via Google |
| 294 | # Cloud calls with request origins within the perimeter. Example: |
| 295 | # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. |
| 296 | # For Service Perimeter Bridge, must be empty. |
| 297 | "A String", |
| 298 | ], |
| 299 | "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter |
| 300 | # restrictions. For example, if `storage.googleapis.com` is specified, access |
| 301 | # to the storage buckets inside the perimeter must meet the perimeter's |
| 302 | # access restrictions. |
| 303 | "A String", |
| 304 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 305 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 306 | } |
| 307 | |
| 308 | x__xgafv: string, V1 error format. |
| 309 | Allowed values |
| 310 | 1 - v1 error format |
| 311 | 2 - v2 error format |
| 312 | |
| 313 | Returns: |
| 314 | An object of the form: |
| 315 | |
| 316 | { # This resource represents a long-running operation that is the result of a |
| 317 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 318 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 319 | # originally returns it. If you use the default HTTP mapping, the |
| 320 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 321 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 322 | # contains progress information and common metadata such as create time. |
| 323 | # Some services might not provide such metadata. Any method that returns a |
| 324 | # long-running operation should document the metadata type, if any. |
| 325 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 326 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 327 | "response": { # The normal response of the operation in case of success. If the original |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 328 | # method returns no data on success, such as `Delete`, the response is |
| 329 | # `google.protobuf.Empty`. If the original method is standard |
| 330 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 331 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 332 | # is the original method name. For example, if the original method name |
| 333 | # is `TakeSnapshot()`, the inferred response type is |
| 334 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 335 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 336 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 337 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 338 | # If `true`, the operation is completed, and either `error` or `response` is |
| 339 | # available. |
| 340 | "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. |
| 341 | # different programming environments, including REST APIs and RPC APIs. It is |
| 342 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 343 | # three pieces of data: error code, error message, and error details. |
| 344 | # |
| 345 | # You can find out more about this error model and how to work with it in the |
| 346 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 347 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 348 | # message types for APIs to use. |
| 349 | { |
| 350 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 351 | }, |
| 352 | ], |
| 353 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 354 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 355 | # user-facing error message should be localized and sent in the |
| 356 | # google.rpc.Status.details field, or localized by the client. |
| 357 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 358 | }</pre> |
| 359 | </div> |
| 360 | |
| 361 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 362 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 363 | <pre>Delete a Service Perimeter by resource |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 364 | name. The longrunning operation from this RPC will have a successful status |
| 365 | once the Service Perimeter has been |
| 366 | removed from long-lasting storage. |
| 367 | |
| 368 | Args: |
| 369 | name: string, Required. Resource name for the Service Perimeter. |
| 370 | |
| 371 | Format: |
| 372 | `accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}` (required) |
| 373 | x__xgafv: string, V1 error format. |
| 374 | Allowed values |
| 375 | 1 - v1 error format |
| 376 | 2 - v2 error format |
| 377 | |
| 378 | Returns: |
| 379 | An object of the form: |
| 380 | |
| 381 | { # This resource represents a long-running operation that is the result of a |
| 382 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 383 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 384 | # originally returns it. If you use the default HTTP mapping, the |
| 385 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 386 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 387 | # contains progress information and common metadata such as create time. |
| 388 | # Some services might not provide such metadata. Any method that returns a |
| 389 | # long-running operation should document the metadata type, if any. |
| 390 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 391 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 392 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 393 | # method returns no data on success, such as `Delete`, the response is |
| 394 | # `google.protobuf.Empty`. If the original method is standard |
| 395 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 396 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 397 | # is the original method name. For example, if the original method name |
| 398 | # is `TakeSnapshot()`, the inferred response type is |
| 399 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 400 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 401 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 402 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 403 | # If `true`, the operation is completed, and either `error` or `response` is |
| 404 | # available. |
| 405 | "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. |
| 406 | # different programming environments, including REST APIs and RPC APIs. It is |
| 407 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 408 | # three pieces of data: error code, error message, and error details. |
| 409 | # |
| 410 | # You can find out more about this error model and how to work with it in the |
| 411 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 412 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 413 | # message types for APIs to use. |
| 414 | { |
| 415 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 416 | }, |
| 417 | ], |
| 418 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 419 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 420 | # user-facing error message should be localized and sent in the |
| 421 | # google.rpc.Status.details field, or localized by the client. |
| 422 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 423 | }</pre> |
| 424 | </div> |
| 425 | |
| 426 | <div class="method"> |
| 427 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 428 | <pre>Get a Service Perimeter by resource |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 429 | name. |
| 430 | |
| 431 | Args: |
| 432 | name: string, Required. Resource name for the Service Perimeter. |
| 433 | |
| 434 | Format: |
| 435 | `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}` (required) |
| 436 | x__xgafv: string, V1 error format. |
| 437 | Allowed values |
| 438 | 1 - v1 error format |
| 439 | 2 - v2 error format |
| 440 | |
| 441 | Returns: |
| 442 | An object of the form: |
| 443 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 444 | { # `ServicePerimeter` describes a set of Google Cloud resources which can freely |
| 445 | # import and export data amongst themselves, but not export outside of the |
| 446 | # `ServicePerimeter`. If a request with a source within this `ServicePerimeter` |
| 447 | # has a target outside of the `ServicePerimeter`, the request will be blocked. |
| 448 | # Otherwise the request is allowed. There are two types of Service Perimeter - |
| 449 | # Regular and Bridge. Regular Service Perimeters cannot overlap, a single |
| 450 | # Google Cloud project can only belong to a single regular Service Perimeter. |
| 451 | # Service Perimeter Bridges can contain only Google Cloud projects as members, |
| 452 | # a single Google Cloud project may belong to multiple Service Perimeter |
| 453 | # Bridges. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 454 | "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect |
| 455 | # behavior. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 456 | "perimeterType": "A String", # Perimeter type indicator. A single project is |
| 457 | # allowed to be a member of single regular perimeter, but multiple service |
| 458 | # perimeter bridges. A project cannot be a included in a perimeter bridge |
| 459 | # without being included in regular perimeter. For perimeter bridges, |
| 460 | # the restricted service list as well as access level lists must be |
| 461 | # empty. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 462 | "useExplicitDryRunSpec": True or False, # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly |
| 463 | # exists for all Service Perimeters, and that spec is identical to the |
| 464 | # status for those Service Perimeters. When this flag is set, it inhibits the |
| 465 | # generation of the implicit spec, thereby allowing the user to explicitly |
| 466 | # provide a configuration ("spec") to use in a dry-run version of the Service |
| 467 | # Perimeter. This allows the user to test changes to the enforced config |
| 468 | # ("status") without actually enforcing them. This testing is done through |
| 469 | # analyzing the differences between currently enforced and suggested |
| 470 | # restrictions. use_explicit_dry_run_spec must bet set to True if any of the |
| 471 | # fields in the spec are set to non-default values. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 472 | "title": "A String", # Human readable title. Must be unique within the Policy. |
| 473 | "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name` |
| 474 | # component must begin with a letter and only include alphanumeric and '_'. |
| 475 | # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 476 | "spec": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Proposed (or dry run) ServicePerimeter configuration. This configuration |
| 477 | # allows to specify and test ServicePerimeter configuration without enforcing |
| 478 | # actual access restrictions. Only allowed to be set when the |
| 479 | # "use_explicit_dry_run_spec" flag is set. |
| 480 | # describe specific Service Perimeter configuration. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 481 | "resources": [ # A list of Google Cloud resources that are inside of the service perimeter. |
| 482 | # Currently only projects are allowed. Format: `projects/{project_number}` |
| 483 | "A String", |
| 484 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 485 | "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter. |
| 486 | # Perimeter. |
| 487 | "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of |
| 488 | # APIs specified in 'allowed_services'. |
| 489 | "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty |
| 490 | # unless 'enable_restriction' is True. |
| 491 | "A String", |
| 492 | ], |
| 493 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 494 | "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the |
| 495 | # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed |
| 496 | # must be in the same policy as this `ServicePerimeter`. Referencing a |
| 497 | # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are |
| 498 | # listed, resources within the perimeter can only be accessed via Google |
| 499 | # Cloud calls with request origins within the perimeter. Example: |
| 500 | # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. |
| 501 | # For Service Perimeter Bridge, must be empty. |
| 502 | "A String", |
| 503 | ], |
| 504 | "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter |
| 505 | # restrictions. For example, if `storage.googleapis.com` is specified, access |
| 506 | # to the storage buckets inside the perimeter must meet the perimeter's |
| 507 | # access restrictions. |
| 508 | "A String", |
| 509 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 510 | }, |
| 511 | "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources, |
| 512 | # restricted services and access levels that determine perimeter |
| 513 | # content and boundaries. |
| 514 | # describe specific Service Perimeter configuration. |
| 515 | "resources": [ # A list of Google Cloud resources that are inside of the service perimeter. |
| 516 | # Currently only projects are allowed. Format: `projects/{project_number}` |
| 517 | "A String", |
| 518 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 519 | "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter. |
| 520 | # Perimeter. |
| 521 | "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of |
| 522 | # APIs specified in 'allowed_services'. |
| 523 | "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty |
| 524 | # unless 'enable_restriction' is True. |
| 525 | "A String", |
| 526 | ], |
| 527 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 528 | "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the |
| 529 | # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed |
| 530 | # must be in the same policy as this `ServicePerimeter`. Referencing a |
| 531 | # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are |
| 532 | # listed, resources within the perimeter can only be accessed via Google |
| 533 | # Cloud calls with request origins within the perimeter. Example: |
| 534 | # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. |
| 535 | # For Service Perimeter Bridge, must be empty. |
| 536 | "A String", |
| 537 | ], |
| 538 | "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter |
| 539 | # restrictions. For example, if `storage.googleapis.com` is specified, access |
| 540 | # to the storage buckets inside the perimeter must meet the perimeter's |
| 541 | # access restrictions. |
| 542 | "A String", |
| 543 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 544 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 545 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 546 | </div> |
| 547 | |
| 548 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 549 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 550 | <pre>List all Service Perimeters for an |
| 551 | access policy. |
| 552 | |
| 553 | Args: |
| 554 | parent: string, Required. Resource name for the access policy to list Service Perimeters from. |
| 555 | |
| 556 | Format: |
| 557 | `accessPolicies/{policy_id}` (required) |
| 558 | pageToken: string, Next page token for the next batch of Service Perimeter instances. |
| 559 | Defaults to the first page of results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 560 | pageSize: integer, Number of Service Perimeters to include |
| 561 | in the list. Default 100. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 562 | x__xgafv: string, V1 error format. |
| 563 | Allowed values |
| 564 | 1 - v1 error format |
| 565 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 566 | |
| 567 | Returns: |
| 568 | An object of the form: |
| 569 | |
| 570 | { # A response to `ListServicePerimetersRequest`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 571 | "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is |
| 572 | # empty, no further results remain. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 573 | "servicePerimeters": [ # List of the Service Perimeter instances. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 574 | { # `ServicePerimeter` describes a set of Google Cloud resources which can freely |
| 575 | # import and export data amongst themselves, but not export outside of the |
| 576 | # `ServicePerimeter`. If a request with a source within this `ServicePerimeter` |
| 577 | # has a target outside of the `ServicePerimeter`, the request will be blocked. |
| 578 | # Otherwise the request is allowed. There are two types of Service Perimeter - |
| 579 | # Regular and Bridge. Regular Service Perimeters cannot overlap, a single |
| 580 | # Google Cloud project can only belong to a single regular Service Perimeter. |
| 581 | # Service Perimeter Bridges can contain only Google Cloud projects as members, |
| 582 | # a single Google Cloud project may belong to multiple Service Perimeter |
| 583 | # Bridges. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 584 | "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect |
| 585 | # behavior. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 586 | "perimeterType": "A String", # Perimeter type indicator. A single project is |
| 587 | # allowed to be a member of single regular perimeter, but multiple service |
| 588 | # perimeter bridges. A project cannot be a included in a perimeter bridge |
| 589 | # without being included in regular perimeter. For perimeter bridges, |
| 590 | # the restricted service list as well as access level lists must be |
| 591 | # empty. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 592 | "useExplicitDryRunSpec": True or False, # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly |
| 593 | # exists for all Service Perimeters, and that spec is identical to the |
| 594 | # status for those Service Perimeters. When this flag is set, it inhibits the |
| 595 | # generation of the implicit spec, thereby allowing the user to explicitly |
| 596 | # provide a configuration ("spec") to use in a dry-run version of the Service |
| 597 | # Perimeter. This allows the user to test changes to the enforced config |
| 598 | # ("status") without actually enforcing them. This testing is done through |
| 599 | # analyzing the differences between currently enforced and suggested |
| 600 | # restrictions. use_explicit_dry_run_spec must bet set to True if any of the |
| 601 | # fields in the spec are set to non-default values. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 602 | "title": "A String", # Human readable title. Must be unique within the Policy. |
| 603 | "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name` |
| 604 | # component must begin with a letter and only include alphanumeric and '_'. |
| 605 | # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 606 | "spec": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Proposed (or dry run) ServicePerimeter configuration. This configuration |
| 607 | # allows to specify and test ServicePerimeter configuration without enforcing |
| 608 | # actual access restrictions. Only allowed to be set when the |
| 609 | # "use_explicit_dry_run_spec" flag is set. |
| 610 | # describe specific Service Perimeter configuration. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 611 | "resources": [ # A list of Google Cloud resources that are inside of the service perimeter. |
| 612 | # Currently only projects are allowed. Format: `projects/{project_number}` |
| 613 | "A String", |
| 614 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 615 | "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter. |
| 616 | # Perimeter. |
| 617 | "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of |
| 618 | # APIs specified in 'allowed_services'. |
| 619 | "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty |
| 620 | # unless 'enable_restriction' is True. |
| 621 | "A String", |
| 622 | ], |
| 623 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 624 | "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the |
| 625 | # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed |
| 626 | # must be in the same policy as this `ServicePerimeter`. Referencing a |
| 627 | # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are |
| 628 | # listed, resources within the perimeter can only be accessed via Google |
| 629 | # Cloud calls with request origins within the perimeter. Example: |
| 630 | # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. |
| 631 | # For Service Perimeter Bridge, must be empty. |
| 632 | "A String", |
| 633 | ], |
| 634 | "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter |
| 635 | # restrictions. For example, if `storage.googleapis.com` is specified, access |
| 636 | # to the storage buckets inside the perimeter must meet the perimeter's |
| 637 | # access restrictions. |
| 638 | "A String", |
| 639 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 640 | }, |
| 641 | "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources, |
| 642 | # restricted services and access levels that determine perimeter |
| 643 | # content and boundaries. |
| 644 | # describe specific Service Perimeter configuration. |
| 645 | "resources": [ # A list of Google Cloud resources that are inside of the service perimeter. |
| 646 | # Currently only projects are allowed. Format: `projects/{project_number}` |
| 647 | "A String", |
| 648 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 649 | "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter. |
| 650 | # Perimeter. |
| 651 | "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of |
| 652 | # APIs specified in 'allowed_services'. |
| 653 | "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty |
| 654 | # unless 'enable_restriction' is True. |
| 655 | "A String", |
| 656 | ], |
| 657 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 658 | "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the |
| 659 | # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed |
| 660 | # must be in the same policy as this `ServicePerimeter`. Referencing a |
| 661 | # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are |
| 662 | # listed, resources within the perimeter can only be accessed via Google |
| 663 | # Cloud calls with request origins within the perimeter. Example: |
| 664 | # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. |
| 665 | # For Service Perimeter Bridge, must be empty. |
| 666 | "A String", |
| 667 | ], |
| 668 | "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter |
| 669 | # restrictions. For example, if `storage.googleapis.com` is specified, access |
| 670 | # to the storage buckets inside the perimeter must meet the perimeter's |
| 671 | # access restrictions. |
| 672 | "A String", |
| 673 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 674 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 675 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 676 | ], |
| 677 | }</pre> |
| 678 | </div> |
| 679 | |
| 680 | <div class="method"> |
| 681 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 682 | <pre>Retrieves the next page of results. |
| 683 | |
| 684 | Args: |
| 685 | previous_request: The request for the previous page. (required) |
| 686 | previous_response: The response from the request for the previous page. (required) |
| 687 | |
| 688 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 689 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 690 | page. Returns None if there are no more items in the collection. |
| 691 | </pre> |
| 692 | </div> |
| 693 | |
| 694 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 695 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 696 | <pre>Update a Service Perimeter. The |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 697 | longrunning operation from this RPC will have a successful status once the |
| 698 | changes to the Service Perimeter have |
| 699 | propagated to long-lasting storage. Service Perimeter containing |
| 700 | errors will result in an error response for the first error encountered. |
| 701 | |
| 702 | Args: |
| 703 | name: string, Required. Resource name for the ServicePerimeter. The `short_name` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 704 | component must begin with a letter and only include alphanumeric and '_'. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 705 | Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 706 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 707 | The object takes the form of: |
| 708 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 709 | { # `ServicePerimeter` describes a set of Google Cloud resources which can freely |
| 710 | # import and export data amongst themselves, but not export outside of the |
| 711 | # `ServicePerimeter`. If a request with a source within this `ServicePerimeter` |
| 712 | # has a target outside of the `ServicePerimeter`, the request will be blocked. |
| 713 | # Otherwise the request is allowed. There are two types of Service Perimeter - |
| 714 | # Regular and Bridge. Regular Service Perimeters cannot overlap, a single |
| 715 | # Google Cloud project can only belong to a single regular Service Perimeter. |
| 716 | # Service Perimeter Bridges can contain only Google Cloud projects as members, |
| 717 | # a single Google Cloud project may belong to multiple Service Perimeter |
| 718 | # Bridges. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 719 | "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect |
| 720 | # behavior. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 721 | "perimeterType": "A String", # Perimeter type indicator. A single project is |
| 722 | # allowed to be a member of single regular perimeter, but multiple service |
| 723 | # perimeter bridges. A project cannot be a included in a perimeter bridge |
| 724 | # without being included in regular perimeter. For perimeter bridges, |
| 725 | # the restricted service list as well as access level lists must be |
| 726 | # empty. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 727 | "useExplicitDryRunSpec": True or False, # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly |
| 728 | # exists for all Service Perimeters, and that spec is identical to the |
| 729 | # status for those Service Perimeters. When this flag is set, it inhibits the |
| 730 | # generation of the implicit spec, thereby allowing the user to explicitly |
| 731 | # provide a configuration ("spec") to use in a dry-run version of the Service |
| 732 | # Perimeter. This allows the user to test changes to the enforced config |
| 733 | # ("status") without actually enforcing them. This testing is done through |
| 734 | # analyzing the differences between currently enforced and suggested |
| 735 | # restrictions. use_explicit_dry_run_spec must bet set to True if any of the |
| 736 | # fields in the spec are set to non-default values. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 737 | "title": "A String", # Human readable title. Must be unique within the Policy. |
| 738 | "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name` |
| 739 | # component must begin with a letter and only include alphanumeric and '_'. |
| 740 | # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 741 | "spec": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Proposed (or dry run) ServicePerimeter configuration. This configuration |
| 742 | # allows to specify and test ServicePerimeter configuration without enforcing |
| 743 | # actual access restrictions. Only allowed to be set when the |
| 744 | # "use_explicit_dry_run_spec" flag is set. |
| 745 | # describe specific Service Perimeter configuration. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 746 | "resources": [ # A list of Google Cloud resources that are inside of the service perimeter. |
| 747 | # Currently only projects are allowed. Format: `projects/{project_number}` |
| 748 | "A String", |
| 749 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 750 | "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter. |
| 751 | # Perimeter. |
| 752 | "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of |
| 753 | # APIs specified in 'allowed_services'. |
| 754 | "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty |
| 755 | # unless 'enable_restriction' is True. |
| 756 | "A String", |
| 757 | ], |
| 758 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 759 | "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the |
| 760 | # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed |
| 761 | # must be in the same policy as this `ServicePerimeter`. Referencing a |
| 762 | # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are |
| 763 | # listed, resources within the perimeter can only be accessed via Google |
| 764 | # Cloud calls with request origins within the perimeter. Example: |
| 765 | # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. |
| 766 | # For Service Perimeter Bridge, must be empty. |
| 767 | "A String", |
| 768 | ], |
| 769 | "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter |
| 770 | # restrictions. For example, if `storage.googleapis.com` is specified, access |
| 771 | # to the storage buckets inside the perimeter must meet the perimeter's |
| 772 | # access restrictions. |
| 773 | "A String", |
| 774 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 775 | }, |
| 776 | "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources, |
| 777 | # restricted services and access levels that determine perimeter |
| 778 | # content and boundaries. |
| 779 | # describe specific Service Perimeter configuration. |
| 780 | "resources": [ # A list of Google Cloud resources that are inside of the service perimeter. |
| 781 | # Currently only projects are allowed. Format: `projects/{project_number}` |
| 782 | "A String", |
| 783 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 784 | "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter. |
| 785 | # Perimeter. |
| 786 | "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of |
| 787 | # APIs specified in 'allowed_services'. |
| 788 | "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty |
| 789 | # unless 'enable_restriction' is True. |
| 790 | "A String", |
| 791 | ], |
| 792 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 793 | "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the |
| 794 | # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed |
| 795 | # must be in the same policy as this `ServicePerimeter`. Referencing a |
| 796 | # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are |
| 797 | # listed, resources within the perimeter can only be accessed via Google |
| 798 | # Cloud calls with request origins within the perimeter. Example: |
| 799 | # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. |
| 800 | # For Service Perimeter Bridge, must be empty. |
| 801 | "A String", |
| 802 | ], |
| 803 | "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter |
| 804 | # restrictions. For example, if `storage.googleapis.com` is specified, access |
| 805 | # to the storage buckets inside the perimeter must meet the perimeter's |
| 806 | # access restrictions. |
| 807 | "A String", |
| 808 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 809 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 810 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 811 | |
| 812 | updateMask: string, Required. Mask to control which fields get updated. Must be non-empty. |
| 813 | x__xgafv: string, V1 error format. |
| 814 | Allowed values |
| 815 | 1 - v1 error format |
| 816 | 2 - v2 error format |
| 817 | |
| 818 | Returns: |
| 819 | An object of the form: |
| 820 | |
| 821 | { # This resource represents a long-running operation that is the result of a |
| 822 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 823 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 824 | # originally returns it. If you use the default HTTP mapping, the |
| 825 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 826 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 827 | # contains progress information and common metadata such as create time. |
| 828 | # Some services might not provide such metadata. Any method that returns a |
| 829 | # long-running operation should document the metadata type, if any. |
| 830 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 831 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 832 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 833 | # method returns no data on success, such as `Delete`, the response is |
| 834 | # `google.protobuf.Empty`. If the original method is standard |
| 835 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 836 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 837 | # is the original method name. For example, if the original method name |
| 838 | # is `TakeSnapshot()`, the inferred response type is |
| 839 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 840 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 841 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 842 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 843 | # If `true`, the operation is completed, and either `error` or `response` is |
| 844 | # available. |
| 845 | "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. |
| 846 | # different programming environments, including REST APIs and RPC APIs. It is |
| 847 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 848 | # three pieces of data: error code, error message, and error details. |
| 849 | # |
| 850 | # You can find out more about this error model and how to work with it in the |
| 851 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 852 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 853 | # message types for APIs to use. |
| 854 | { |
| 855 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 856 | }, |
| 857 | ], |
| 858 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 859 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 860 | # user-facing error message should be localized and sent in the |
| 861 | # google.rpc.Status.details field, or localized by the client. |
| 862 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 863 | }</pre> |
| 864 | </div> |
| 865 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 866 | <div class="method"> |
| 867 | <code class="details" id="replaceAll">replaceAll(parent, body=None, x__xgafv=None)</code> |
| 868 | <pre>Replace all existing Service Perimeters in an |
| 869 | Access Policy |
| 870 | with the Service Perimeters provided. |
| 871 | This is done atomically. The longrunning operation from this |
| 872 | RPC will have a successful status once all replacements have propagated to |
| 873 | long-lasting storage. Replacements containing errors will result in an |
| 874 | error response for the first error encountered. Replacement will be |
| 875 | cancelled on error, existing Service Perimeters will not be |
| 876 | affected. Operation.response field will contain |
| 877 | ReplaceServicePerimetersResponse. |
| 878 | |
| 879 | Args: |
| 880 | parent: string, Required. Resource name for the access policy which owns these |
| 881 | Service Perimeters. |
| 882 | |
| 883 | Format: `accessPolicies/{policy_id}` (required) |
| 884 | body: object, The request body. |
| 885 | The object takes the form of: |
| 886 | |
| 887 | { # A request to replace all existing Service Perimeters in an Access Policy |
| 888 | # with the Service Perimeters provided. This is done atomically. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 889 | "servicePerimeters": [ # Required. The desired Service Perimeters that should |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 890 | # replace all existing Service Perimeters in the |
| 891 | # Access Policy. |
| 892 | { # `ServicePerimeter` describes a set of Google Cloud resources which can freely |
| 893 | # import and export data amongst themselves, but not export outside of the |
| 894 | # `ServicePerimeter`. If a request with a source within this `ServicePerimeter` |
| 895 | # has a target outside of the `ServicePerimeter`, the request will be blocked. |
| 896 | # Otherwise the request is allowed. There are two types of Service Perimeter - |
| 897 | # Regular and Bridge. Regular Service Perimeters cannot overlap, a single |
| 898 | # Google Cloud project can only belong to a single regular Service Perimeter. |
| 899 | # Service Perimeter Bridges can contain only Google Cloud projects as members, |
| 900 | # a single Google Cloud project may belong to multiple Service Perimeter |
| 901 | # Bridges. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 902 | "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect |
| 903 | # behavior. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 904 | "perimeterType": "A String", # Perimeter type indicator. A single project is |
| 905 | # allowed to be a member of single regular perimeter, but multiple service |
| 906 | # perimeter bridges. A project cannot be a included in a perimeter bridge |
| 907 | # without being included in regular perimeter. For perimeter bridges, |
| 908 | # the restricted service list as well as access level lists must be |
| 909 | # empty. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 910 | "useExplicitDryRunSpec": True or False, # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly |
| 911 | # exists for all Service Perimeters, and that spec is identical to the |
| 912 | # status for those Service Perimeters. When this flag is set, it inhibits the |
| 913 | # generation of the implicit spec, thereby allowing the user to explicitly |
| 914 | # provide a configuration ("spec") to use in a dry-run version of the Service |
| 915 | # Perimeter. This allows the user to test changes to the enforced config |
| 916 | # ("status") without actually enforcing them. This testing is done through |
| 917 | # analyzing the differences between currently enforced and suggested |
| 918 | # restrictions. use_explicit_dry_run_spec must bet set to True if any of the |
| 919 | # fields in the spec are set to non-default values. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 920 | "title": "A String", # Human readable title. Must be unique within the Policy. |
| 921 | "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name` |
| 922 | # component must begin with a letter and only include alphanumeric and '_'. |
| 923 | # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 924 | "spec": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Proposed (or dry run) ServicePerimeter configuration. This configuration |
| 925 | # allows to specify and test ServicePerimeter configuration without enforcing |
| 926 | # actual access restrictions. Only allowed to be set when the |
| 927 | # "use_explicit_dry_run_spec" flag is set. |
| 928 | # describe specific Service Perimeter configuration. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 929 | "resources": [ # A list of Google Cloud resources that are inside of the service perimeter. |
| 930 | # Currently only projects are allowed. Format: `projects/{project_number}` |
| 931 | "A String", |
| 932 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 933 | "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter. |
| 934 | # Perimeter. |
| 935 | "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of |
| 936 | # APIs specified in 'allowed_services'. |
| 937 | "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty |
| 938 | # unless 'enable_restriction' is True. |
| 939 | "A String", |
| 940 | ], |
| 941 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 942 | "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the |
| 943 | # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed |
| 944 | # must be in the same policy as this `ServicePerimeter`. Referencing a |
| 945 | # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are |
| 946 | # listed, resources within the perimeter can only be accessed via Google |
| 947 | # Cloud calls with request origins within the perimeter. Example: |
| 948 | # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. |
| 949 | # For Service Perimeter Bridge, must be empty. |
| 950 | "A String", |
| 951 | ], |
| 952 | "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter |
| 953 | # restrictions. For example, if `storage.googleapis.com` is specified, access |
| 954 | # to the storage buckets inside the perimeter must meet the perimeter's |
| 955 | # access restrictions. |
| 956 | "A String", |
| 957 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 958 | }, |
| 959 | "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources, |
| 960 | # restricted services and access levels that determine perimeter |
| 961 | # content and boundaries. |
| 962 | # describe specific Service Perimeter configuration. |
| 963 | "resources": [ # A list of Google Cloud resources that are inside of the service perimeter. |
| 964 | # Currently only projects are allowed. Format: `projects/{project_number}` |
| 965 | "A String", |
| 966 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 967 | "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter. |
| 968 | # Perimeter. |
| 969 | "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of |
| 970 | # APIs specified in 'allowed_services'. |
| 971 | "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty |
| 972 | # unless 'enable_restriction' is True. |
| 973 | "A String", |
| 974 | ], |
| 975 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 976 | "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the |
| 977 | # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed |
| 978 | # must be in the same policy as this `ServicePerimeter`. Referencing a |
| 979 | # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are |
| 980 | # listed, resources within the perimeter can only be accessed via Google |
| 981 | # Cloud calls with request origins within the perimeter. Example: |
| 982 | # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. |
| 983 | # For Service Perimeter Bridge, must be empty. |
| 984 | "A String", |
| 985 | ], |
| 986 | "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter |
| 987 | # restrictions. For example, if `storage.googleapis.com` is specified, access |
| 988 | # to the storage buckets inside the perimeter must meet the perimeter's |
| 989 | # access restrictions. |
| 990 | "A String", |
| 991 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 992 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 993 | }, |
| 994 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 995 | "etag": "A String", # Optional. The etag for the version of the Access Policy that this |
| 996 | # replace operation is to be performed on. If, at the time of replace, the |
| 997 | # etag for the Access Policy stored in Access Context Manager is different |
| 998 | # from the specified etag, then the replace operation will not be performed |
| 999 | # and the call will fail. This field is not required. If etag is not |
| 1000 | # provided, the operation will be performed as if a valid etag is provided. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1001 | } |
| 1002 | |
| 1003 | x__xgafv: string, V1 error format. |
| 1004 | Allowed values |
| 1005 | 1 - v1 error format |
| 1006 | 2 - v2 error format |
| 1007 | |
| 1008 | Returns: |
| 1009 | An object of the form: |
| 1010 | |
| 1011 | { # This resource represents a long-running operation that is the result of a |
| 1012 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1013 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 1014 | # originally returns it. If you use the default HTTP mapping, the |
| 1015 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1016 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 1017 | # contains progress information and common metadata such as create time. |
| 1018 | # Some services might not provide such metadata. Any method that returns a |
| 1019 | # long-running operation should document the metadata type, if any. |
| 1020 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1021 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1022 | "response": { # The normal response of the operation in case of success. If the original |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1023 | # method returns no data on success, such as `Delete`, the response is |
| 1024 | # `google.protobuf.Empty`. If the original method is standard |
| 1025 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 1026 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 1027 | # is the original method name. For example, if the original method name |
| 1028 | # is `TakeSnapshot()`, the inferred response type is |
| 1029 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1030 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1031 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1032 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 1033 | # If `true`, the operation is completed, and either `error` or `response` is |
| 1034 | # available. |
| 1035 | "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. |
| 1036 | # different programming environments, including REST APIs and RPC APIs. It is |
| 1037 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 1038 | # three pieces of data: error code, error message, and error details. |
| 1039 | # |
| 1040 | # You can find out more about this error model and how to work with it in the |
| 1041 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 1042 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 1043 | # message types for APIs to use. |
| 1044 | { |
| 1045 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1046 | }, |
| 1047 | ], |
| 1048 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1049 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 1050 | # user-facing error message should be localized and sent in the |
| 1051 | # google.rpc.Status.details field, or localized by the client. |
| 1052 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1053 | }</pre> |
| 1054 | </div> |
| 1055 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1056 | </body></html> |