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_v1beta.html">Access Context Manager API</a> . <a href="accesscontextmanager_v1beta.accessPolicies.html">accessPolicies</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="accesscontextmanager_v1beta.accessPolicies.accessLevels.html">accessLevels()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the accessLevels Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="accesscontextmanager_v1beta.accessPolicies.servicePerimeters.html">servicePerimeters()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the servicePerimeters Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 88 | <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 89 | <p class="firstline">Create an `AccessPolicy`. Fails if this organization already has a</p> |
| 90 | <p class="toc_element"> |
| 91 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 92 | <p class="firstline">Delete an AccessPolicy by resource</p> |
| 93 | <p class="toc_element"> |
| 94 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 95 | <p class="firstline">Get an AccessPolicy by name.</p> |
| 96 | <p class="toc_element"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 97 | <code><a href="#list">list(pageToken=None, pageSize=None, parent=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | <p class="firstline">List all AccessPolicies under a</p> |
| 99 | <p class="toc_element"> |
| 100 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 101 | <p class="firstline">Retrieves the next page of results.</p> |
| 102 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 103 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 104 | <p class="firstline">Update an AccessPolicy. The</p> |
| 105 | <h3>Method Details</h3> |
| 106 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 107 | <code class="details" id="create">create(body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 108 | <pre>Create an `AccessPolicy`. Fails if this organization already has a |
| 109 | `AccessPolicy`. The longrunning Operation will have a successful status |
| 110 | once the `AccessPolicy` has propagated to long-lasting storage. |
| 111 | Syntactic and basic semantic errors will be returned in `metadata` as a |
| 112 | BadRequest proto. |
| 113 | |
| 114 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 115 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 116 | The object takes the form of: |
| 117 | |
| 118 | { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 119 | # attributes to use Google Cloud services) and `ServicePerimeters` (which |
| 120 | # define regions of services able to freely pass data within a perimeter). An |
| 121 | # access policy is globally visible within an organization, and the |
| 122 | # restrictions it specifies apply to all projects within an organization. |
| 123 | "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource |
| 124 | # Hierarchy. Currently immutable once created. Format: |
| 125 | # `organizations/{organization_id}` |
| 126 | "title": "A String", # Required. Human readable title. Does not affect behavior. |
| 127 | "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format: |
| 128 | # `accessPolicies/{policy_id}` |
| 129 | } |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 130 | |
| 131 | x__xgafv: string, V1 error format. |
| 132 | Allowed values |
| 133 | 1 - v1 error format |
| 134 | 2 - v2 error format |
| 135 | |
| 136 | Returns: |
| 137 | An object of the form: |
| 138 | |
| 139 | { # This resource represents a long-running operation that is the result of a |
| 140 | # network API call. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 141 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 142 | # originally returns it. If you use the default HTTP mapping, the |
| 143 | # `name` should be a resource name ending with `operations/{unique_id}`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 144 | "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. |
| 145 | # different programming environments, including REST APIs and RPC APIs. It is |
| 146 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 147 | # three pieces of data: error code, error message, and error details. |
| 148 | # |
| 149 | # You can find out more about this error model and how to work with it in the |
| 150 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 151 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 152 | # message types for APIs to use. |
| 153 | { |
| 154 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 155 | }, |
| 156 | ], |
| 157 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 158 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 159 | # user-facing error message should be localized and sent in the |
| 160 | # google.rpc.Status.details field, or localized by the client. |
| 161 | }, |
| 162 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 163 | # contains progress information and common metadata such as create time. |
| 164 | # Some services might not provide such metadata. Any method that returns a |
| 165 | # long-running operation should document the metadata type, if any. |
| 166 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 167 | }, |
| 168 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 169 | # If `true`, the operation is completed, and either `error` or `response` is |
| 170 | # available. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 171 | "response": { # The normal response of the operation in case of success. If the original |
| 172 | # method returns no data on success, such as `Delete`, the response is |
| 173 | # `google.protobuf.Empty`. If the original method is standard |
| 174 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 175 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 176 | # is the original method name. For example, if the original method name |
| 177 | # is `TakeSnapshot()`, the inferred response type is |
| 178 | # `TakeSnapshotResponse`. |
| 179 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 180 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 181 | }</pre> |
| 182 | </div> |
| 183 | |
| 184 | <div class="method"> |
| 185 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 186 | <pre>Delete an AccessPolicy by resource |
| 187 | name. The longrunning Operation will have a successful status once the |
| 188 | AccessPolicy |
| 189 | has been removed from long-lasting storage. |
| 190 | |
| 191 | Args: |
| 192 | name: string, Required. Resource name for the access policy to delete. |
| 193 | |
| 194 | Format `accessPolicies/{policy_id}` (required) |
| 195 | x__xgafv: string, V1 error format. |
| 196 | Allowed values |
| 197 | 1 - v1 error format |
| 198 | 2 - v2 error format |
| 199 | |
| 200 | Returns: |
| 201 | An object of the form: |
| 202 | |
| 203 | { # This resource represents a long-running operation that is the result of a |
| 204 | # network API call. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 205 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 206 | # originally returns it. If you use the default HTTP mapping, the |
| 207 | # `name` should be a resource name ending with `operations/{unique_id}`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 208 | "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. |
| 209 | # different programming environments, including REST APIs and RPC APIs. It is |
| 210 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 211 | # three pieces of data: error code, error message, and error details. |
| 212 | # |
| 213 | # You can find out more about this error model and how to work with it in the |
| 214 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 215 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 216 | # message types for APIs to use. |
| 217 | { |
| 218 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 219 | }, |
| 220 | ], |
| 221 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 222 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 223 | # user-facing error message should be localized and sent in the |
| 224 | # google.rpc.Status.details field, or localized by the client. |
| 225 | }, |
| 226 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 227 | # contains progress information and common metadata such as create time. |
| 228 | # Some services might not provide such metadata. Any method that returns a |
| 229 | # long-running operation should document the metadata type, if any. |
| 230 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 231 | }, |
| 232 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 233 | # If `true`, the operation is completed, and either `error` or `response` is |
| 234 | # available. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 235 | "response": { # The normal response of the operation in case of success. If the original |
| 236 | # method returns no data on success, such as `Delete`, the response is |
| 237 | # `google.protobuf.Empty`. If the original method is standard |
| 238 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 239 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 240 | # is the original method name. For example, if the original method name |
| 241 | # is `TakeSnapshot()`, the inferred response type is |
| 242 | # `TakeSnapshotResponse`. |
| 243 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 244 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 245 | }</pre> |
| 246 | </div> |
| 247 | |
| 248 | <div class="method"> |
| 249 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 250 | <pre>Get an AccessPolicy by name. |
| 251 | |
| 252 | Args: |
| 253 | name: string, Required. Resource name for the access policy to get. |
| 254 | |
| 255 | Format `accessPolicies/{policy_id}` (required) |
| 256 | x__xgafv: string, V1 error format. |
| 257 | Allowed values |
| 258 | 1 - v1 error format |
| 259 | 2 - v2 error format |
| 260 | |
| 261 | Returns: |
| 262 | An object of the form: |
| 263 | |
| 264 | { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 265 | # attributes to use Google Cloud services) and `ServicePerimeters` (which |
| 266 | # define regions of services able to freely pass data within a perimeter). An |
| 267 | # access policy is globally visible within an organization, and the |
| 268 | # restrictions it specifies apply to all projects within an organization. |
| 269 | "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource |
| 270 | # Hierarchy. Currently immutable once created. Format: |
| 271 | # `organizations/{organization_id}` |
| 272 | "title": "A String", # Required. Human readable title. Does not affect behavior. |
| 273 | "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format: |
| 274 | # `accessPolicies/{policy_id}` |
| 275 | }</pre> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 276 | </div> |
| 277 | |
| 278 | <div class="method"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 279 | <code class="details" id="list">list(pageToken=None, pageSize=None, parent=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 280 | <pre>List all AccessPolicies under a |
| 281 | container. |
| 282 | |
| 283 | Args: |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 284 | pageToken: string, Next page token for the next batch of AccessPolicy instances. Defaults to |
| 285 | the first page of results. |
| 286 | pageSize: integer, Number of AccessPolicy instances to include in the list. Default 100. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 287 | parent: string, Required. Resource name for the container to list AccessPolicy instances |
| 288 | from. |
| 289 | |
| 290 | Format: |
| 291 | `organizations/{org_id}` |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 292 | x__xgafv: string, V1 error format. |
| 293 | Allowed values |
| 294 | 1 - v1 error format |
| 295 | 2 - v2 error format |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 296 | |
| 297 | Returns: |
| 298 | An object of the form: |
| 299 | |
| 300 | { # A response to `ListAccessPoliciesRequest`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 301 | "accessPolicies": [ # List of the AccessPolicy instances. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 302 | { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 303 | # attributes to use Google Cloud services) and `ServicePerimeters` (which |
| 304 | # define regions of services able to freely pass data within a perimeter). An |
| 305 | # access policy is globally visible within an organization, and the |
| 306 | # restrictions it specifies apply to all projects within an organization. |
| 307 | "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource |
| 308 | # Hierarchy. Currently immutable once created. Format: |
| 309 | # `organizations/{organization_id}` |
| 310 | "title": "A String", # Required. Human readable title. Does not affect behavior. |
| 311 | "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format: |
| 312 | # `accessPolicies/{policy_id}` |
| 313 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 314 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 315 | "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is |
| 316 | # empty, no further results remain. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 317 | }</pre> |
| 318 | </div> |
| 319 | |
| 320 | <div class="method"> |
| 321 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 322 | <pre>Retrieves the next page of results. |
| 323 | |
| 324 | Args: |
| 325 | previous_request: The request for the previous page. (required) |
| 326 | previous_response: The response from the request for the previous page. (required) |
| 327 | |
| 328 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 329 | 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] | 330 | page. Returns None if there are no more items in the collection. |
| 331 | </pre> |
| 332 | </div> |
| 333 | |
| 334 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 335 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 336 | <pre>Update an AccessPolicy. The |
| 337 | longrunning Operation from this RPC will have a successful status once the |
| 338 | changes to the AccessPolicy have propagated |
| 339 | to long-lasting storage. Syntactic and basic semantic errors will be |
| 340 | returned in `metadata` as a BadRequest proto. |
| 341 | |
| 342 | Args: |
| 343 | name: string, Output only. Resource name of the `AccessPolicy`. Format: |
| 344 | `accessPolicies/{policy_id}` (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 345 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 346 | The object takes the form of: |
| 347 | |
| 348 | { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 349 | # attributes to use Google Cloud services) and `ServicePerimeters` (which |
| 350 | # define regions of services able to freely pass data within a perimeter). An |
| 351 | # access policy is globally visible within an organization, and the |
| 352 | # restrictions it specifies apply to all projects within an organization. |
| 353 | "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource |
| 354 | # Hierarchy. Currently immutable once created. Format: |
| 355 | # `organizations/{organization_id}` |
| 356 | "title": "A String", # Required. Human readable title. Does not affect behavior. |
| 357 | "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format: |
| 358 | # `accessPolicies/{policy_id}` |
| 359 | } |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 360 | |
| 361 | updateMask: string, Required. Mask to control which fields get updated. Must be non-empty. |
| 362 | x__xgafv: string, V1 error format. |
| 363 | Allowed values |
| 364 | 1 - v1 error format |
| 365 | 2 - v2 error format |
| 366 | |
| 367 | Returns: |
| 368 | An object of the form: |
| 369 | |
| 370 | { # This resource represents a long-running operation that is the result of a |
| 371 | # network API call. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 372 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 373 | # originally returns it. If you use the default HTTP mapping, the |
| 374 | # `name` should be a resource name ending with `operations/{unique_id}`. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 375 | "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. |
| 376 | # different programming environments, including REST APIs and RPC APIs. It is |
| 377 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 378 | # three pieces of data: error code, error message, and error details. |
| 379 | # |
| 380 | # You can find out more about this error model and how to work with it in the |
| 381 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 382 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 383 | # message types for APIs to use. |
| 384 | { |
| 385 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 386 | }, |
| 387 | ], |
| 388 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 389 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 390 | # user-facing error message should be localized and sent in the |
| 391 | # google.rpc.Status.details field, or localized by the client. |
| 392 | }, |
| 393 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 394 | # contains progress information and common metadata such as create time. |
| 395 | # Some services might not provide such metadata. Any method that returns a |
| 396 | # long-running operation should document the metadata type, if any. |
| 397 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 398 | }, |
| 399 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 400 | # If `true`, the operation is completed, and either `error` or `response` is |
| 401 | # available. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 402 | "response": { # The normal response of the operation in case of success. If the original |
| 403 | # method returns no data on success, such as `Delete`, the response is |
| 404 | # `google.protobuf.Empty`. If the original method is standard |
| 405 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 406 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 407 | # is the original method name. For example, if the original method name |
| 408 | # is `TakeSnapshot()`, the inferred response type is |
| 409 | # `TakeSnapshotResponse`. |
| 410 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 411 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 412 | }</pre> |
| 413 | </div> |
| 414 | |
| 415 | </body></html> |