| 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="serviceconsumermanagement_v1.html">Service Consumer Management API</a> . <a href="serviceconsumermanagement_v1.services.html">services</a> . <a href="serviceconsumermanagement_v1.services.tenancyUnits.html">tenancyUnits</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="#addProject">addProject(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Add a new tenant project to the tenancy unit.</p> |
| 80 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#applyProjectConfig">applyProjectConfig(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Apply a configuration to an existing tenant project.</p> |
| 83 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 84 | <code><a href="#attachProject">attachProject(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 85 | <p class="firstline">Attach an existing project to the tenancy unit as a new tenant</p> |
| 86 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 87 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Creates a tenancy unit with no tenant resources.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Delete a tenancy unit. Before you delete the tenancy unit, there should be</p> |
| 92 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#deleteProject">deleteProject(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <p class="firstline">Deletes the specified project resource identified by a tenant resource tag.</p> |
| 95 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 96 | <code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="firstline">Find the tenancy unit for a managed service and service consumer.</p> |
| 98 | <p class="toc_element"> |
| 99 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 100 | <p class="firstline">Retrieves the next page of results.</p> |
| 101 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 102 | <code><a href="#removeProject">removeProject(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | <p class="firstline">Removes the specified project resource identified by a tenant resource tag.</p> |
| 104 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | <code><a href="#undeleteProject">undeleteProject(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | <p class="firstline">Attempts to undelete a previously deleted tenant project. The project must</p> |
| 107 | <h3>Method Details</h3> |
| 108 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 109 | <code class="details" id="addProject">addProject(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 110 | <pre>Add a new tenant project to the tenancy unit. |
| 111 | There can be a maximum of 512 tenant projects in a tenancy unit. |
| 112 | If there are previously failed `AddTenantProject` calls, you might need to |
| 113 | call `RemoveTenantProject` first to resolve them before you can make |
| 114 | another call to `AddTenantProject` with the same tag. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 115 | Operation<response: Empty>. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 116 | |
| 117 | Args: |
| 118 | parent: string, Name of the tenancy unit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 119 | Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 120 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 121 | The object takes the form of: |
| 122 | |
| 123 | { # Request to add a newly created and configured tenant project to a tenancy |
| 124 | # unit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 125 | "tag": "A String", # Tag of the added project. Must be less than 128 characters. Required. |
| 126 | "projectConfig": { # This structure defines a tenant project to be added to the specified tenancy # Configuration of the new tenant project to be added to tenancy unit |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 127 | # resources. |
| 128 | # unit and its initial configuration and properties. A project lien is created |
| 129 | # for the tenant project to prevent the tenant project from being deleted |
| 130 | # accidentally. The lien is deleted as part of tenant project removal. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 131 | "labels": { # Labels that are applied to this project. |
| 132 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 133 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 134 | "serviceAccountConfig": { # Describes the service account configuration for the tenant project. # Configuration for the IAM service account on the tenant project. |
| 135 | "accountId": "A String", # ID of the IAM service account to be created in tenant project. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 136 | # The email format of the service account is |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 137 | # "<account-id>@<tenant-project-id>.iam.gserviceaccount.com". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 138 | # This account ID must be unique within tenant project and service |
| 139 | # producers have to guarantee it. The ID must be 6-30 characters long, and |
| 140 | # match the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 141 | "tenantProjectRoles": [ # Roles for the associated service account for the tenant project. |
| 142 | "A String", |
| 143 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 144 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 145 | "folder": "A String", # Folder where project in this tenancy unit must be located |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 146 | # This folder must have been previously created with the required |
| 147 | # permissions for the caller to create and configure a project in it. |
| 148 | # Valid folder resource names have the format `folders/{folder_number}` |
| 149 | # (for example, `folders/123456`). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 150 | "tenantProjectPolicy": { # Describes policy settings that need to be applied to a newly # Describes ownership and policies for the new tenant project. Required. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 151 | # created tenant project. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 152 | "policyBindings": [ # Policy bindings to be applied to the tenant project, in addition to the |
| 153 | # 'roles/owner' role granted to the Service Consumer Management service |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 154 | # account. |
| 155 | # At least one binding must have the role `roles/owner`. Among the list of |
| 156 | # members for `roles/owner`, at least one of them must be either the `user` |
| 157 | # or `group` type. |
| 158 | { # Translates to IAM Policy bindings (without auditing at this level) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 159 | "members": [ # Uses the same format as in IAM policy. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 160 | # `member` must include both a prefix and ID. For example, `user:{emailId}`, |
| 161 | # `serviceAccount:{emailId}`, `group:{emailId}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 162 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 163 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 164 | "role": "A String", # Role. (https://cloud.google.com/iam/docs/understanding-roles) |
| 165 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 166 | }, |
| 167 | ], |
| 168 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 169 | "services": [ # Google Cloud API names of services that are activated on this project |
| 170 | # during provisioning. If any of these services can't be activated, |
| 171 | # the request fails. |
| 172 | # For example: 'compute.googleapis.com','cloudfunctions.googleapis.com' |
| 173 | "A String", |
| 174 | ], |
| 175 | "billingConfig": { # Describes the billing configuration for a new tenant project. # Billing account properties. The billing account must be specified. |
| 176 | "billingAccount": "A String", # Name of the billing account. |
| 177 | # For example `billingAccounts/012345-567890-ABCDEF`. |
| 178 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 179 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 180 | } |
| 181 | |
| 182 | x__xgafv: string, V1 error format. |
| 183 | Allowed values |
| 184 | 1 - v1 error format |
| 185 | 2 - v2 error format |
| 186 | |
| 187 | Returns: |
| 188 | An object of the form: |
| 189 | |
| 190 | { # This resource represents a long-running operation that is the result of a |
| 191 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 192 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 193 | # contains progress information and common metadata such as create time. |
| 194 | # Some services might not provide such metadata. Any method that returns a |
| 195 | # long-running operation should document the metadata type, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 196 | "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] | 197 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 198 | "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] | 199 | # method returns no data on success, such as `Delete`, the response is |
| 200 | # `google.protobuf.Empty`. If the original method is standard |
| 201 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 202 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 203 | # is the original method name. For example, if the original method name |
| 204 | # is `TakeSnapshot()`, the inferred response type is |
| 205 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 206 | "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] | 207 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 208 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 209 | # originally returns it. If you use the default HTTP mapping, the |
| 210 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 211 | "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. |
| 212 | # different programming environments, including REST APIs and RPC APIs. It is |
| 213 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 214 | # three pieces of data: error code, error message, and error details. |
| 215 | # |
| 216 | # You can find out more about this error model and how to work with it in the |
| 217 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 218 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 219 | # message types for APIs to use. |
| 220 | { |
| 221 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 222 | }, |
| 223 | ], |
| 224 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 225 | # user-facing error message should be localized and sent in the |
| 226 | # google.rpc.Status.details field, or localized by the client. |
| 227 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 228 | }, |
| 229 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 230 | # If `true`, the operation is completed, and either `error` or `response` is |
| 231 | # available. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 232 | }</pre> |
| 233 | </div> |
| 234 | |
| 235 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 236 | <code class="details" id="applyProjectConfig">applyProjectConfig(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 237 | <pre>Apply a configuration to an existing tenant project. |
| 238 | This project must exist in an active state and have the original owner |
| 239 | account. The caller must have permission to add a project to the given |
| 240 | tenancy unit. The configuration is applied, but any existing settings on |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 241 | the project aren't modified. |
| 242 | Specified policy bindings are applied. Existing bindings aren't modified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 243 | Specified services are activated. No service is deactivated. |
| 244 | If specified, new billing configuration is applied. |
| 245 | Omit a billing configuration to keep the existing one. |
| 246 | A service account in the project is created if previously non existed. |
| 247 | Specified labels will be appended to tenant project, note that the value of |
| 248 | existing label key will be updated if the same label key is requested. |
| 249 | The specified folder is ignored, as moving a tenant project to a different |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 250 | folder isn't supported. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 251 | The operation fails if any of the steps fail, but no rollback of already |
| 252 | applied configuration changes is attempted. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 253 | Operation<response: Empty>. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 254 | |
| 255 | Args: |
| 256 | name: string, Name of the tenancy unit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 257 | Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 258 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 259 | The object takes the form of: |
| 260 | |
| 261 | { # Request to apply configuration to an existing tenant project. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 262 | "tag": "A String", # Tag of the project. Must be less than 128 characters. Required. |
| 263 | "projectConfig": { # This structure defines a tenant project to be added to the specified tenancy # Configuration that should be applied to the existing tenant project. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 264 | # unit and its initial configuration and properties. A project lien is created |
| 265 | # for the tenant project to prevent the tenant project from being deleted |
| 266 | # accidentally. The lien is deleted as part of tenant project removal. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 267 | "labels": { # Labels that are applied to this project. |
| 268 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 269 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 270 | "serviceAccountConfig": { # Describes the service account configuration for the tenant project. # Configuration for the IAM service account on the tenant project. |
| 271 | "accountId": "A String", # ID of the IAM service account to be created in tenant project. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 272 | # The email format of the service account is |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 273 | # "<account-id>@<tenant-project-id>.iam.gserviceaccount.com". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 274 | # This account ID must be unique within tenant project and service |
| 275 | # producers have to guarantee it. The ID must be 6-30 characters long, and |
| 276 | # match the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 277 | "tenantProjectRoles": [ # Roles for the associated service account for the tenant project. |
| 278 | "A String", |
| 279 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 280 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 281 | "folder": "A String", # Folder where project in this tenancy unit must be located |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 282 | # This folder must have been previously created with the required |
| 283 | # permissions for the caller to create and configure a project in it. |
| 284 | # Valid folder resource names have the format `folders/{folder_number}` |
| 285 | # (for example, `folders/123456`). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 286 | "tenantProjectPolicy": { # Describes policy settings that need to be applied to a newly # Describes ownership and policies for the new tenant project. Required. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 287 | # created tenant project. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 288 | "policyBindings": [ # Policy bindings to be applied to the tenant project, in addition to the |
| 289 | # 'roles/owner' role granted to the Service Consumer Management service |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 290 | # account. |
| 291 | # At least one binding must have the role `roles/owner`. Among the list of |
| 292 | # members for `roles/owner`, at least one of them must be either the `user` |
| 293 | # or `group` type. |
| 294 | { # Translates to IAM Policy bindings (without auditing at this level) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 295 | "members": [ # Uses the same format as in IAM policy. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 296 | # `member` must include both a prefix and ID. For example, `user:{emailId}`, |
| 297 | # `serviceAccount:{emailId}`, `group:{emailId}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 298 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 299 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 300 | "role": "A String", # Role. (https://cloud.google.com/iam/docs/understanding-roles) |
| 301 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 302 | }, |
| 303 | ], |
| 304 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 305 | "services": [ # Google Cloud API names of services that are activated on this project |
| 306 | # during provisioning. If any of these services can't be activated, |
| 307 | # the request fails. |
| 308 | # For example: 'compute.googleapis.com','cloudfunctions.googleapis.com' |
| 309 | "A String", |
| 310 | ], |
| 311 | "billingConfig": { # Describes the billing configuration for a new tenant project. # Billing account properties. The billing account must be specified. |
| 312 | "billingAccount": "A String", # Name of the billing account. |
| 313 | # For example `billingAccounts/012345-567890-ABCDEF`. |
| 314 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 315 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 316 | } |
| 317 | |
| 318 | x__xgafv: string, V1 error format. |
| 319 | Allowed values |
| 320 | 1 - v1 error format |
| 321 | 2 - v2 error format |
| 322 | |
| 323 | Returns: |
| 324 | An object of the form: |
| 325 | |
| 326 | { # This resource represents a long-running operation that is the result of a |
| 327 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 328 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 329 | # contains progress information and common metadata such as create time. |
| 330 | # Some services might not provide such metadata. Any method that returns a |
| 331 | # long-running operation should document the metadata type, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 332 | "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] | 333 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 334 | "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] | 335 | # method returns no data on success, such as `Delete`, the response is |
| 336 | # `google.protobuf.Empty`. If the original method is standard |
| 337 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 338 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 339 | # is the original method name. For example, if the original method name |
| 340 | # is `TakeSnapshot()`, the inferred response type is |
| 341 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 342 | "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] | 343 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 344 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 345 | # originally returns it. If you use the default HTTP mapping, the |
| 346 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 347 | "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. |
| 348 | # different programming environments, including REST APIs and RPC APIs. It is |
| 349 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 350 | # three pieces of data: error code, error message, and error details. |
| 351 | # |
| 352 | # You can find out more about this error model and how to work with it in the |
| 353 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 354 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 355 | # message types for APIs to use. |
| 356 | { |
| 357 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 358 | }, |
| 359 | ], |
| 360 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 361 | # user-facing error message should be localized and sent in the |
| 362 | # google.rpc.Status.details field, or localized by the client. |
| 363 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 364 | }, |
| 365 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 366 | # If `true`, the operation is completed, and either `error` or `response` is |
| 367 | # available. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 368 | }</pre> |
| 369 | </div> |
| 370 | |
| 371 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 372 | <code class="details" id="attachProject">attachProject(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 373 | <pre>Attach an existing project to the tenancy unit as a new tenant |
| 374 | resource. The project could either be the tenant project reserved by |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 375 | calling `AddTenantProject` under a tenancy unit of a service producer's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 376 | project of a managed service, or from a separate project. |
| 377 | The caller is checked against a set of permissions as if calling |
| 378 | `AddTenantProject` on the same service consumer. |
| 379 | To trigger the attachment, the targeted tenant project must be in a |
| 380 | folder. Make sure the ServiceConsumerManagement service account is |
| 381 | the owner of that project. These two requirements are already met |
| 382 | if the project is reserved by calling `AddTenantProject`. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 383 | Operation<response: Empty>. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 384 | |
| 385 | Args: |
| 386 | name: string, Name of the tenancy unit that the project will be attached to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 387 | Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 388 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 389 | The object takes the form of: |
| 390 | |
| 391 | { # Request to attach an existing project to the tenancy unit as a new tenant |
| 392 | # resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 393 | "reservedResource": "A String", # When attaching a reserved project already in tenancy units, this is the |
| 394 | # tag of a tenant resource under the tenancy unit for the managed service's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 395 | # service producer project. The reserved tenant resource must be in an |
| 396 | # active state. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 397 | "tag": "A String", # Tag of the tenant resource after attachment. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 398 | # Must be less than 128 characters. Required. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 399 | "externalResource": "A String", # When attaching an external project, this is in the format of |
| 400 | # `projects/{project_number}`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 401 | } |
| 402 | |
| 403 | x__xgafv: string, V1 error format. |
| 404 | Allowed values |
| 405 | 1 - v1 error format |
| 406 | 2 - v2 error format |
| 407 | |
| 408 | Returns: |
| 409 | An object of the form: |
| 410 | |
| 411 | { # This resource represents a long-running operation that is the result of a |
| 412 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 413 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 414 | # contains progress information and common metadata such as create time. |
| 415 | # Some services might not provide such metadata. Any method that returns a |
| 416 | # long-running operation should document the metadata type, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 417 | "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] | 418 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 419 | "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] | 420 | # method returns no data on success, such as `Delete`, the response is |
| 421 | # `google.protobuf.Empty`. If the original method is standard |
| 422 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 423 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 424 | # is the original method name. For example, if the original method name |
| 425 | # is `TakeSnapshot()`, the inferred response type is |
| 426 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 427 | "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] | 428 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 429 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 430 | # originally returns it. If you use the default HTTP mapping, the |
| 431 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 432 | "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. |
| 433 | # different programming environments, including REST APIs and RPC APIs. It is |
| 434 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 435 | # three pieces of data: error code, error message, and error details. |
| 436 | # |
| 437 | # You can find out more about this error model and how to work with it in the |
| 438 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 439 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 440 | # message types for APIs to use. |
| 441 | { |
| 442 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 443 | }, |
| 444 | ], |
| 445 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 446 | # user-facing error message should be localized and sent in the |
| 447 | # google.rpc.Status.details field, or localized by the client. |
| 448 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 449 | }, |
| 450 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 451 | # If `true`, the operation is completed, and either `error` or `response` is |
| 452 | # available. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 453 | }</pre> |
| 454 | </div> |
| 455 | |
| 456 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 457 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 458 | <pre>Creates a tenancy unit with no tenant resources. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 459 | If tenancy unit already exists, it will be returned, |
| 460 | however, in this case, returned TenancyUnit does not have tenant_resources |
| 461 | field set and ListTenancyUnit has to be used to get a complete |
| 462 | TenancyUnit with all fields populated. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 463 | |
| 464 | Args: |
| 465 | parent: string, services/{service}/{collection id}/{resource id} |
| 466 | {collection id} is the cloud resource collection type representing the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 467 | service consumer, for example 'projects', or 'organizations'. |
| 468 | {resource id} is the consumer numeric id, such as project number: '123456'. |
| 469 | {service} the name of a managed service, such as 'service.googleapis.com'. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 470 | Enables service binding using the new tenancy unit. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 471 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 472 | The object takes the form of: |
| 473 | |
| 474 | { # Request to create a tenancy unit for a service consumer of a managed service. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 475 | "tenancyUnitId": "A String", # Optional service producer-provided identifier of the tenancy unit. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 476 | # Must be no longer than 40 characters and preferably URI friendly. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 477 | # If it isn't provided, a UID for the tenancy unit is automatically |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 478 | # generated. The identifier must be unique across a managed service. |
| 479 | # If the tenancy unit already exists for the managed service and service |
| 480 | # consumer pair, calling `CreateTenancyUnit` returns the existing tenancy |
| 481 | # unit if the provided identifier is identical or empty, otherwise the call |
| 482 | # fails. |
| 483 | } |
| 484 | |
| 485 | x__xgafv: string, V1 error format. |
| 486 | Allowed values |
| 487 | 1 - v1 error format |
| 488 | 2 - v2 error format |
| 489 | |
| 490 | Returns: |
| 491 | An object of the form: |
| 492 | |
| 493 | { # Representation of a tenancy unit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 494 | "tenantResources": [ # Resources constituting the tenancy unit. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 495 | # There can be at most 512 tenant resources in a tenancy unit. |
| 496 | { # Resource constituting the TenancyUnit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 497 | "status": "A String", # Status of tenant resource. |
| 498 | "tag": "A String", # Unique per single tenancy unit. |
| 499 | "resource": "A String", # @OutputOnly Identifier of the tenant resource. |
| 500 | # For cloud projects, it is in the form 'projects/{number}'. |
| 501 | # For example 'projects/123456'. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 502 | }, |
| 503 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 504 | "name": "A String", # Globally unique identifier of this tenancy unit |
| 505 | # "services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}" |
| 506 | "createTime": "A String", # @OutputOnly The time this tenancy unit was created. |
| 507 | "service": "A String", # Output only. Google Cloud API name of the managed service owning this |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 508 | # tenancy unit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 509 | # For example 'serviceconsumermanagement.googleapis.com'. |
| 510 | "consumer": "A String", # @OutputOnly Cloud resource name of the consumer of this service. |
| 511 | # For example 'projects/123456'. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 512 | }</pre> |
| 513 | </div> |
| 514 | |
| 515 | <div class="method"> |
| 516 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 517 | <pre>Delete a tenancy unit. Before you delete the tenancy unit, there should be |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 518 | no tenant resources in it that aren't in a DELETED state. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 519 | Operation<response: Empty>. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 520 | |
| 521 | Args: |
| 522 | name: string, Name of the tenancy unit to be deleted. (required) |
| 523 | x__xgafv: string, V1 error format. |
| 524 | Allowed values |
| 525 | 1 - v1 error format |
| 526 | 2 - v2 error format |
| 527 | |
| 528 | Returns: |
| 529 | An object of the form: |
| 530 | |
| 531 | { # This resource represents a long-running operation that is the result of a |
| 532 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 533 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 534 | # contains progress information and common metadata such as create time. |
| 535 | # Some services might not provide such metadata. Any method that returns a |
| 536 | # long-running operation should document the metadata type, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 537 | "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] | 538 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 539 | "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] | 540 | # method returns no data on success, such as `Delete`, the response is |
| 541 | # `google.protobuf.Empty`. If the original method is standard |
| 542 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 543 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 544 | # is the original method name. For example, if the original method name |
| 545 | # is `TakeSnapshot()`, the inferred response type is |
| 546 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 547 | "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] | 548 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 549 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 550 | # originally returns it. If you use the default HTTP mapping, the |
| 551 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 552 | "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. |
| 553 | # different programming environments, including REST APIs and RPC APIs. It is |
| 554 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 555 | # three pieces of data: error code, error message, and error details. |
| 556 | # |
| 557 | # You can find out more about this error model and how to work with it in the |
| 558 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 559 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 560 | # message types for APIs to use. |
| 561 | { |
| 562 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 563 | }, |
| 564 | ], |
| 565 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 566 | # user-facing error message should be localized and sent in the |
| 567 | # google.rpc.Status.details field, or localized by the client. |
| 568 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 569 | }, |
| 570 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 571 | # If `true`, the operation is completed, and either `error` or `response` is |
| 572 | # available. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 573 | }</pre> |
| 574 | </div> |
| 575 | |
| 576 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 577 | <code class="details" id="deleteProject">deleteProject(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 578 | <pre>Deletes the specified project resource identified by a tenant resource tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 579 | The mothod removes a project lien with a 'TenantManager' origin if that was |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 580 | added. It will then attempt to delete the project. If that operation fails, |
| 581 | this method also fails. |
| 582 | After the project has been deleted, the tenant resource state is set to |
| 583 | DELETED. To permanently remove resource metadata, call the |
| 584 | `RemoveTenantProject` method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 585 | New resources with the same tag can't be added if there are existing |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 586 | resources in a DELETED state. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 587 | Operation<response: Empty>. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 588 | |
| 589 | Args: |
| 590 | name: string, Name of the tenancy unit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 591 | Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 592 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 593 | The object takes the form of: |
| 594 | |
| 595 | { # Request message to delete tenant project resource from the tenancy unit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 596 | "tag": "A String", # Tag of the resource within the tenancy unit. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 597 | } |
| 598 | |
| 599 | x__xgafv: string, V1 error format. |
| 600 | Allowed values |
| 601 | 1 - v1 error format |
| 602 | 2 - v2 error format |
| 603 | |
| 604 | Returns: |
| 605 | An object of the form: |
| 606 | |
| 607 | { # This resource represents a long-running operation that is the result of a |
| 608 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 609 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 610 | # contains progress information and common metadata such as create time. |
| 611 | # Some services might not provide such metadata. Any method that returns a |
| 612 | # long-running operation should document the metadata type, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 613 | "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] | 614 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 615 | "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] | 616 | # method returns no data on success, such as `Delete`, the response is |
| 617 | # `google.protobuf.Empty`. If the original method is standard |
| 618 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 619 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 620 | # is the original method name. For example, if the original method name |
| 621 | # is `TakeSnapshot()`, the inferred response type is |
| 622 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 623 | "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] | 624 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 625 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 626 | # originally returns it. If you use the default HTTP mapping, the |
| 627 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 628 | "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. |
| 629 | # different programming environments, including REST APIs and RPC APIs. It is |
| 630 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 631 | # three pieces of data: error code, error message, and error details. |
| 632 | # |
| 633 | # You can find out more about this error model and how to work with it in the |
| 634 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 635 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 636 | # message types for APIs to use. |
| 637 | { |
| 638 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 639 | }, |
| 640 | ], |
| 641 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 642 | # user-facing error message should be localized and sent in the |
| 643 | # google.rpc.Status.details field, or localized by the client. |
| 644 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 645 | }, |
| 646 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 647 | # If `true`, the operation is completed, and either `error` or `response` is |
| 648 | # available. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 649 | }</pre> |
| 650 | </div> |
| 651 | |
| 652 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 653 | <code class="details" id="list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 654 | <pre>Find the tenancy unit for a managed service and service consumer. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 655 | This method shouldn't be used in a service producer's runtime path, for |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 656 | example to find the tenant project number when creating VMs. Service |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 657 | producers must persist the tenant project's information after the project |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 658 | is created. |
| 659 | |
| 660 | Args: |
| 661 | parent: string, Managed service and service consumer. Required. |
| 662 | services/{service}/{collection id}/{resource id} |
| 663 | {collection id} is the cloud resource collection type representing the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 664 | service consumer, for example 'projects', or 'organizations'. |
| 665 | {resource id} is the consumer numeric id, such as project number: '123456'. |
| 666 | {service} the name of a service, such as 'service.googleapis.com'. (required) |
| 667 | filter: string, Filter expression over tenancy resources field. Optional. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 668 | pageToken: string, The continuation token, which is used to page through large result sets. |
| 669 | To get the next page of results, set this parameter to the value of |
| 670 | `nextPageToken` from the previous response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 671 | pageSize: integer, The maximum number of results returned by this request. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 672 | x__xgafv: string, V1 error format. |
| 673 | Allowed values |
| 674 | 1 - v1 error format |
| 675 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 676 | |
| 677 | Returns: |
| 678 | An object of the form: |
| 679 | |
| 680 | { # Response for the list request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 681 | "tenancyUnits": [ # Tenancy units matching the request. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 682 | { # Representation of a tenancy unit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 683 | "tenantResources": [ # Resources constituting the tenancy unit. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 684 | # There can be at most 512 tenant resources in a tenancy unit. |
| 685 | { # Resource constituting the TenancyUnit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 686 | "status": "A String", # Status of tenant resource. |
| 687 | "tag": "A String", # Unique per single tenancy unit. |
| 688 | "resource": "A String", # @OutputOnly Identifier of the tenant resource. |
| 689 | # For cloud projects, it is in the form 'projects/{number}'. |
| 690 | # For example 'projects/123456'. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 691 | }, |
| 692 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 693 | "name": "A String", # Globally unique identifier of this tenancy unit |
| 694 | # "services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}" |
| 695 | "createTime": "A String", # @OutputOnly The time this tenancy unit was created. |
| 696 | "service": "A String", # Output only. Google Cloud API name of the managed service owning this |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 697 | # tenancy unit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 698 | # For example 'serviceconsumermanagement.googleapis.com'. |
| 699 | "consumer": "A String", # @OutputOnly Cloud resource name of the consumer of this service. |
| 700 | # For example 'projects/123456'. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 701 | }, |
| 702 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 703 | "nextPageToken": "A String", # Pagination token for large results. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 704 | }</pre> |
| 705 | </div> |
| 706 | |
| 707 | <div class="method"> |
| 708 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 709 | <pre>Retrieves the next page of results. |
| 710 | |
| 711 | Args: |
| 712 | previous_request: The request for the previous page. (required) |
| 713 | previous_response: The response from the request for the previous page. (required) |
| 714 | |
| 715 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 716 | 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] | 717 | page. Returns None if there are no more items in the collection. |
| 718 | </pre> |
| 719 | </div> |
| 720 | |
| 721 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 722 | <code class="details" id="removeProject">removeProject(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 723 | <pre>Removes the specified project resource identified by a tenant resource tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 724 | The method removes the project lien with 'TenantManager' origin if that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 725 | was added. It then attempts to delete the project. If that operation |
| 726 | fails, this method also fails. |
| 727 | Calls to remove already removed or non-existent tenant project succeed. |
| 728 | After the project has been deleted, or if was already in a DELETED state, |
| 729 | resource metadata is permanently removed from the tenancy unit. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 730 | Operation<response: Empty>. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 731 | |
| 732 | Args: |
| 733 | name: string, Name of the tenancy unit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 734 | Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 735 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 736 | The object takes the form of: |
| 737 | |
| 738 | { # Request message to remove a tenant project resource from the tenancy unit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 739 | "tag": "A String", # Tag of the resource within the tenancy unit. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 740 | } |
| 741 | |
| 742 | x__xgafv: string, V1 error format. |
| 743 | Allowed values |
| 744 | 1 - v1 error format |
| 745 | 2 - v2 error format |
| 746 | |
| 747 | Returns: |
| 748 | An object of the form: |
| 749 | |
| 750 | { # This resource represents a long-running operation that is the result of a |
| 751 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 752 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 753 | # contains progress information and common metadata such as create time. |
| 754 | # Some services might not provide such metadata. Any method that returns a |
| 755 | # long-running operation should document the metadata type, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 756 | "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] | 757 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 758 | "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] | 759 | # method returns no data on success, such as `Delete`, the response is |
| 760 | # `google.protobuf.Empty`. If the original method is standard |
| 761 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 762 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 763 | # is the original method name. For example, if the original method name |
| 764 | # is `TakeSnapshot()`, the inferred response type is |
| 765 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 766 | "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] | 767 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 768 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 769 | # originally returns it. If you use the default HTTP mapping, the |
| 770 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 771 | "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. |
| 772 | # different programming environments, including REST APIs and RPC APIs. It is |
| 773 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 774 | # three pieces of data: error code, error message, and error details. |
| 775 | # |
| 776 | # You can find out more about this error model and how to work with it in the |
| 777 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 778 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 779 | # message types for APIs to use. |
| 780 | { |
| 781 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 782 | }, |
| 783 | ], |
| 784 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 785 | # user-facing error message should be localized and sent in the |
| 786 | # google.rpc.Status.details field, or localized by the client. |
| 787 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 788 | }, |
| 789 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 790 | # If `true`, the operation is completed, and either `error` or `response` is |
| 791 | # available. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 792 | }</pre> |
| 793 | </div> |
| 794 | |
| 795 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 796 | <code class="details" id="undeleteProject">undeleteProject(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 797 | <pre>Attempts to undelete a previously deleted tenant project. The project must |
| 798 | be in a DELETED state. |
| 799 | There are no guarantees that an undeleted project will be in |
| 800 | a fully restored and functional state. Call the `ApplyTenantProjectConfig` |
| 801 | method to update its configuration and then validate all managed service |
| 802 | resources. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 803 | Operation<response: Empty>. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 804 | |
| 805 | Args: |
| 806 | name: string, Name of the tenancy unit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 807 | Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 808 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 809 | The object takes the form of: |
| 810 | |
| 811 | { # Request message to undelete tenant project resource previously deleted from |
| 812 | # the tenancy unit. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 813 | "tag": "A String", # Tag of the resource within the tenancy unit. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 814 | } |
| 815 | |
| 816 | x__xgafv: string, V1 error format. |
| 817 | Allowed values |
| 818 | 1 - v1 error format |
| 819 | 2 - v2 error format |
| 820 | |
| 821 | Returns: |
| 822 | An object of the form: |
| 823 | |
| 824 | { # This resource represents a long-running operation that is the result of a |
| 825 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 826 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 830 | "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] | 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 | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 842 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 843 | # originally returns it. If you use the default HTTP mapping, the |
| 844 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 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 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 859 | # user-facing error message should be localized and sent in the |
| 860 | # google.rpc.Status.details field, or localized by the client. |
| 861 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 862 | }, |
| 863 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 864 | # If `true`, the operation is completed, and either `error` or `response` is |
| 865 | # available. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 866 | }</pre> |
| 867 | </div> |
| 868 | |
| 869 | </body></html> |