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="deploymentmanager_v2.html">Google Cloud Deployment Manager API</a> . <a href="deploymentmanager_v2.deployments.html">deployments</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#cancelPreview">cancelPreview(project, deployment, body)</a></code></p> 79 <p class="firstline">Cancels and removes the preview currently associated with the deployment.</p> 80 <p class="toc_element"> 81 <code><a href="#delete">delete(project, deployment, deletePolicy=None)</a></code></p> 82 <p class="firstline">Deletes a deployment and all of the resources in the deployment.</p> 83 <p class="toc_element"> 84 <code><a href="#get">get(project, deployment)</a></code></p> 85 <p class="firstline">Gets information about a specific deployment.</p> 86 <p class="toc_element"> 87 <code><a href="#getIamPolicy">getIamPolicy(project, resource)</a></code></p> 88 <p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> 89 <p class="toc_element"> 90 <code><a href="#insert">insert(project, body, preview=None)</a></code></p> 91 <p class="firstline">Creates a deployment and all of the resources described by the deployment manifest.</p> 92 <p class="toc_element"> 93 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 94 <p class="firstline">Lists all deployments for a given project.</p> 95 <p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97 <p class="firstline">Retrieves the next page of results.</p> 98 <p class="toc_element"> 99 <code><a href="#patch">patch(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</a></code></p> 100 <p class="firstline">Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.</p> 101 <p class="toc_element"> 102 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body)</a></code></p> 103 <p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 104 <p class="toc_element"> 105 <code><a href="#stop">stop(project, deployment, body)</a></code></p> 106 <p class="firstline">Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.</p> 107 <p class="toc_element"> 108 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 109 <p class="firstline">Returns permissions that a caller has on the specified resource.</p> 110 <p class="toc_element"> 111 <code><a href="#update">update(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</a></code></p> 112 <p class="firstline">Updates a deployment and all of the resources described by the deployment manifest.</p> 113 <h3>Method Details</h3> 114 <div class="method"> 115 <code class="details" id="cancelPreview">cancelPreview(project, deployment, body)</code> 116 <pre>Cancels and removes the preview currently associated with the deployment. 117 118 Args: 119 project: string, The project ID for this request. (required) 120 deployment: string, The name of the deployment for this request. (required) 121 body: object, The request body. (required) 122 The object takes the form of: 123 124 { 125 "fingerprint": "A String", # Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests). 126 # 127 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. 128 } 129 130 131 Returns: 132 An object of the form: 133 134 { # An Operation resource, used to manage asynchronous API requests. 135 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 136 "clientOperationId": "A String", # [Output Only] Reserved for future use. 137 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 138 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 139 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 140 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 141 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 142 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 143 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 144 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 145 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 146 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 147 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 148 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 149 { 150 "message": "A String", # [Output Only] A human-readable description of the warning code. 151 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 152 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 153 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 154 { 155 "value": "A String", # [Output Only] A warning data value corresponding to the key. 156 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 157 }, 158 ], 159 }, 160 ], 161 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 162 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 163 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 164 "name": "A String", # [Output Only] Name of the resource. 165 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 166 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 167 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 168 { 169 "message": "A String", # [Output Only] An optional, human-readable error message. 170 "code": "A String", # [Output Only] The error type identifier for this error. 171 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 172 }, 173 ], 174 }, 175 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 176 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 177 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 178 }</pre> 179 </div> 180 181 <div class="method"> 182 <code class="details" id="delete">delete(project, deployment, deletePolicy=None)</code> 183 <pre>Deletes a deployment and all of the resources in the deployment. 184 185 Args: 186 project: string, The project ID for this request. (required) 187 deployment: string, The name of the deployment for this request. (required) 188 deletePolicy: string, Sets the policy to use for deleting resources. 189 Allowed values 190 ABANDON - 191 DELETE - 192 193 Returns: 194 An object of the form: 195 196 { # An Operation resource, used to manage asynchronous API requests. 197 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 198 "clientOperationId": "A String", # [Output Only] Reserved for future use. 199 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 200 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 201 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 202 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 203 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 204 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 205 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 206 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 207 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 208 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 209 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 210 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 211 { 212 "message": "A String", # [Output Only] A human-readable description of the warning code. 213 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 214 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 215 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 216 { 217 "value": "A String", # [Output Only] A warning data value corresponding to the key. 218 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 219 }, 220 ], 221 }, 222 ], 223 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 224 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 225 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 226 "name": "A String", # [Output Only] Name of the resource. 227 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 228 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 229 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 230 { 231 "message": "A String", # [Output Only] An optional, human-readable error message. 232 "code": "A String", # [Output Only] The error type identifier for this error. 233 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 234 }, 235 ], 236 }, 237 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 238 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 239 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 240 }</pre> 241 </div> 242 243 <div class="method"> 244 <code class="details" id="get">get(project, deployment)</code> 245 <pre>Gets information about a specific deployment. 246 247 Args: 248 project: string, The project ID for this request. (required) 249 deployment: string, The name of the deployment for this request. (required) 250 251 Returns: 252 An object of the form: 253 254 { 255 "description": "A String", # An optional user-provided description of the deployment. 256 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? 257 { 258 "value": "A String", 259 "key": "A String", 260 }, 261 ], 262 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. 263 "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? 264 { 265 "value": "A String", 266 "key": "A String", 267 }, 268 ], 269 "description": "A String", # [Output Only] An optional user-provided description of the deployment after the current update has been applied. 270 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment. 271 }, 272 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed. 273 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format . 274 "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. 275 # 276 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. 277 "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment. 278 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 279 "clientOperationId": "A String", # [Output Only] Reserved for future use. 280 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 281 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 282 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 283 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 284 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 285 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 286 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 287 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 288 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 289 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 290 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 291 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 292 { 293 "message": "A String", # [Output Only] A human-readable description of the warning code. 294 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 295 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 296 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 297 { 298 "value": "A String", # [Output Only] A warning data value corresponding to the key. 299 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 300 }, 301 ], 302 }, 303 ], 304 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 305 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 306 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 307 "name": "A String", # [Output Only] Name of the resource. 308 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 309 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 310 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 311 { 312 "message": "A String", # [Output Only] An optional, human-readable error message. 313 "code": "A String", # [Output Only] The error type identifier for this error. 314 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 315 }, 316 ], 317 }, 318 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 319 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 320 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 321 }, 322 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. 323 "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. 324 { 325 "content": "A String", # The contents of the file. 326 "name": "A String", # The name of the file. 327 }, 328 ], 329 "config": { # The configuration to use for this deployment. 330 "content": "A String", # The contents of the file. 331 }, 332 }, 333 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 334 "selfLink": "A String", # [Output Only] Self link for the deployment. 335 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 336 }</pre> 337 </div> 338 339 <div class="method"> 340 <code class="details" id="getIamPolicy">getIamPolicy(project, resource)</code> 341 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 342 343 Args: 344 project: string, Project ID for this request. (required) 345 resource: string, Name of the resource for this request. (required) 346 347 Returns: 348 An object of the form: 349 350 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 351 # 352 # 353 # 354 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 355 # 356 # **Example** 357 # 358 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike (a] example.com", "group:admins (a] example.com", "domain:google.com", "serviceAccount:my-other-app (a] appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean (a] example.com"] } ] } 359 # 360 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 361 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 362 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. 363 # 364 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. 365 # 366 # Example Policy with multiple AuditConfigs: 367 # 368 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar (a] gmail.com" ] } ] } ] } 369 # 370 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo (a] gmail.com from DATA_READ logging, and bar (a] gmail.com from DATA_WRITE logging. 371 "exemptedMembers": [ 372 "A String", 373 ], 374 "auditLogConfigs": [ # The configuration for logging of each type of permission. 375 { # Provides the configuration for logging a type of permissions. Example: 376 # 377 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 378 # 379 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo (a] gmail.com from DATA_READ logging. 380 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 381 "A String", 382 ], 383 "logType": "A String", # The log type that this config enables. 384 }, 385 ], 386 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 387 }, 388 ], 389 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 390 { # A rule to be applied in a Policy. 391 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 392 { # Specifies what kind of log the caller must write 393 "counter": { # Options for counters # Counter options. 394 "field": "A String", # The field value to attribute. 395 "metric": "A String", # The metric to update. 396 }, 397 }, 398 ], 399 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 400 "A String", 401 ], 402 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 403 "A String", 404 ], 405 "action": "A String", # Required 406 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 407 "A String", 408 ], 409 "conditions": [ # Additional restrictions that must be met 410 { # A condition to be met. 411 "iam": "A String", # Trusted attributes supplied by the IAM system. 412 "svc": "A String", # Trusted attributes discharged by the service. 413 "value": "A String", # DEPRECATED. Use 'values' instead. 414 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 415 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 416 "A String", 417 ], 418 "op": "A String", # An operator to apply the subject with. 419 }, 420 ], 421 "description": "A String", # Human-readable description of the rule. 422 }, 423 ], 424 "version": 42, # Version of the `Policy`. The default version is 0. 425 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. 426 # 427 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 428 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 429 { # Associates `members` with a `role`. 430 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 431 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 432 # 433 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 434 # 435 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 436 # 437 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice (a] gmail.com` or `joe (a] example.com`. 438 # 439 # 440 # 441 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app (a] appspot.gserviceaccount.com`. 442 # 443 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins (a] example.com`. 444 # 445 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 446 "A String", 447 ], 448 }, 449 ], 450 "iamOwned": True or False, 451 }</pre> 452 </div> 453 454 <div class="method"> 455 <code class="details" id="insert">insert(project, body, preview=None)</code> 456 <pre>Creates a deployment and all of the resources described by the deployment manifest. 457 458 Args: 459 project: string, The project ID for this request. (required) 460 body: object, The request body. (required) 461 The object takes the form of: 462 463 { 464 "description": "A String", # An optional user-provided description of the deployment. 465 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? 466 { 467 "value": "A String", 468 "key": "A String", 469 }, 470 ], 471 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. 472 "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? 473 { 474 "value": "A String", 475 "key": "A String", 476 }, 477 ], 478 "description": "A String", # [Output Only] An optional user-provided description of the deployment after the current update has been applied. 479 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment. 480 }, 481 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed. 482 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format . 483 "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. 484 # 485 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. 486 "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment. 487 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 488 "clientOperationId": "A String", # [Output Only] Reserved for future use. 489 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 490 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 491 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 492 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 493 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 494 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 495 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 496 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 497 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 498 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 499 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 500 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 501 { 502 "message": "A String", # [Output Only] A human-readable description of the warning code. 503 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 504 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 505 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 506 { 507 "value": "A String", # [Output Only] A warning data value corresponding to the key. 508 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 509 }, 510 ], 511 }, 512 ], 513 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 514 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 515 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 516 "name": "A String", # [Output Only] Name of the resource. 517 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 518 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 519 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 520 { 521 "message": "A String", # [Output Only] An optional, human-readable error message. 522 "code": "A String", # [Output Only] The error type identifier for this error. 523 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 524 }, 525 ], 526 }, 527 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 528 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 529 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 530 }, 531 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. 532 "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. 533 { 534 "content": "A String", # The contents of the file. 535 "name": "A String", # The name of the file. 536 }, 537 ], 538 "config": { # The configuration to use for this deployment. 539 "content": "A String", # The contents of the file. 540 }, 541 }, 542 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 543 "selfLink": "A String", # [Output Only] Self link for the deployment. 544 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 545 } 546 547 preview: boolean, If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. 548 549 Returns: 550 An object of the form: 551 552 { # An Operation resource, used to manage asynchronous API requests. 553 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 554 "clientOperationId": "A String", # [Output Only] Reserved for future use. 555 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 556 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 557 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 558 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 559 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 560 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 561 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 562 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 563 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 564 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 565 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 566 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 567 { 568 "message": "A String", # [Output Only] A human-readable description of the warning code. 569 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 570 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 571 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 572 { 573 "value": "A String", # [Output Only] A warning data value corresponding to the key. 574 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 575 }, 576 ], 577 }, 578 ], 579 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 580 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 581 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 582 "name": "A String", # [Output Only] Name of the resource. 583 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 584 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 585 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 586 { 587 "message": "A String", # [Output Only] An optional, human-readable error message. 588 "code": "A String", # [Output Only] The error type identifier for this error. 589 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 590 }, 591 ], 592 }, 593 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 594 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 595 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 596 }</pre> 597 </div> 598 599 <div class="method"> 600 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 601 <pre>Lists all deployments for a given project. 602 603 Args: 604 project: string, The project ID for this request. (required) 605 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 606 607 You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. 608 609 Currently, only sorting by name or creationTimestamp desc is supported. 610 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) 611 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. 612 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 613 614 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 615 616 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 617 618 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 619 620 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 621 622 Returns: 623 An object of the form: 624 625 { # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated. 626 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request. 627 "deployments": [ # [Output Only] The deployments contained in this response. 628 { 629 "description": "A String", # An optional user-provided description of the deployment. 630 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? 631 { 632 "value": "A String", 633 "key": "A String", 634 }, 635 ], 636 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. 637 "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? 638 { 639 "value": "A String", 640 "key": "A String", 641 }, 642 ], 643 "description": "A String", # [Output Only] An optional user-provided description of the deployment after the current update has been applied. 644 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment. 645 }, 646 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed. 647 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format . 648 "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. 649 # 650 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. 651 "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment. 652 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 653 "clientOperationId": "A String", # [Output Only] Reserved for future use. 654 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 655 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 656 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 657 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 658 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 659 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 660 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 661 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 662 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 663 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 664 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 665 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 666 { 667 "message": "A String", # [Output Only] A human-readable description of the warning code. 668 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 669 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 670 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 671 { 672 "value": "A String", # [Output Only] A warning data value corresponding to the key. 673 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 674 }, 675 ], 676 }, 677 ], 678 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 679 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 680 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 681 "name": "A String", # [Output Only] Name of the resource. 682 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 683 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 684 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 685 { 686 "message": "A String", # [Output Only] An optional, human-readable error message. 687 "code": "A String", # [Output Only] The error type identifier for this error. 688 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 689 }, 690 ], 691 }, 692 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 693 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 694 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 695 }, 696 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. 697 "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. 698 { 699 "content": "A String", # The contents of the file. 700 "name": "A String", # The name of the file. 701 }, 702 ], 703 "config": { # The configuration to use for this deployment. 704 "content": "A String", # The contents of the file. 705 }, 706 }, 707 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 708 "selfLink": "A String", # [Output Only] Self link for the deployment. 709 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 710 }, 711 ], 712 }</pre> 713 </div> 714 715 <div class="method"> 716 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 717 <pre>Retrieves the next page of results. 718 719 Args: 720 previous_request: The request for the previous page. (required) 721 previous_response: The response from the request for the previous page. (required) 722 723 Returns: 724 A request object that you can call 'execute()' on to request the next 725 page. Returns None if there are no more items in the collection. 726 </pre> 727 </div> 728 729 <div class="method"> 730 <code class="details" id="patch">patch(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</code> 731 <pre>Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics. 732 733 Args: 734 project: string, The project ID for this request. (required) 735 deployment: string, The name of the deployment for this request. (required) 736 body: object, The request body. (required) 737 The object takes the form of: 738 739 { 740 "description": "A String", # An optional user-provided description of the deployment. 741 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? 742 { 743 "value": "A String", 744 "key": "A String", 745 }, 746 ], 747 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. 748 "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? 749 { 750 "value": "A String", 751 "key": "A String", 752 }, 753 ], 754 "description": "A String", # [Output Only] An optional user-provided description of the deployment after the current update has been applied. 755 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment. 756 }, 757 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed. 758 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format . 759 "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. 760 # 761 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. 762 "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment. 763 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 764 "clientOperationId": "A String", # [Output Only] Reserved for future use. 765 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 766 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 767 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 768 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 769 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 770 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 771 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 772 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 773 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 774 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 775 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 776 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 777 { 778 "message": "A String", # [Output Only] A human-readable description of the warning code. 779 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 780 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 781 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 782 { 783 "value": "A String", # [Output Only] A warning data value corresponding to the key. 784 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 785 }, 786 ], 787 }, 788 ], 789 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 790 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 791 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 792 "name": "A String", # [Output Only] Name of the resource. 793 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 794 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 795 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 796 { 797 "message": "A String", # [Output Only] An optional, human-readable error message. 798 "code": "A String", # [Output Only] The error type identifier for this error. 799 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 800 }, 801 ], 802 }, 803 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 804 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 805 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 806 }, 807 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. 808 "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. 809 { 810 "content": "A String", # The contents of the file. 811 "name": "A String", # The name of the file. 812 }, 813 ], 814 "config": { # The configuration to use for this deployment. 815 "content": "A String", # The contents of the file. 816 }, 817 }, 818 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 819 "selfLink": "A String", # [Output Only] Self link for the deployment. 820 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 821 } 822 823 deletePolicy: string, Sets the policy to use for deleting resources. 824 Allowed values 825 ABANDON - 826 DELETE - 827 createPolicy: string, Sets the policy to use for creating new resources. 828 Allowed values 829 ACQUIRE - 830 CREATE_OR_ACQUIRE - 831 preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. 832 833 Returns: 834 An object of the form: 835 836 { # An Operation resource, used to manage asynchronous API requests. 837 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 838 "clientOperationId": "A String", # [Output Only] Reserved for future use. 839 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 840 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 841 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 842 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 843 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 844 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 845 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 846 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 847 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 848 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 849 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 850 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 851 { 852 "message": "A String", # [Output Only] A human-readable description of the warning code. 853 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 854 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 855 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 856 { 857 "value": "A String", # [Output Only] A warning data value corresponding to the key. 858 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 859 }, 860 ], 861 }, 862 ], 863 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 864 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 865 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 866 "name": "A String", # [Output Only] Name of the resource. 867 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 868 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 869 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 870 { 871 "message": "A String", # [Output Only] An optional, human-readable error message. 872 "code": "A String", # [Output Only] The error type identifier for this error. 873 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 874 }, 875 ], 876 }, 877 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 878 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 879 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 880 }</pre> 881 </div> 882 883 <div class="method"> 884 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body)</code> 885 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 886 887 Args: 888 project: string, Project ID for this request. (required) 889 resource: string, Name of the resource for this request. (required) 890 body: object, The request body. (required) 891 The object takes the form of: 892 893 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 894 # 895 # 896 # 897 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 898 # 899 # **Example** 900 # 901 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike (a] example.com", "group:admins (a] example.com", "domain:google.com", "serviceAccount:my-other-app (a] appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean (a] example.com"] } ] } 902 # 903 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 904 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 905 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. 906 # 907 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. 908 # 909 # Example Policy with multiple AuditConfigs: 910 # 911 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar (a] gmail.com" ] } ] } ] } 912 # 913 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo (a] gmail.com from DATA_READ logging, and bar (a] gmail.com from DATA_WRITE logging. 914 "exemptedMembers": [ 915 "A String", 916 ], 917 "auditLogConfigs": [ # The configuration for logging of each type of permission. 918 { # Provides the configuration for logging a type of permissions. Example: 919 # 920 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 921 # 922 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo (a] gmail.com from DATA_READ logging. 923 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 924 "A String", 925 ], 926 "logType": "A String", # The log type that this config enables. 927 }, 928 ], 929 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 930 }, 931 ], 932 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 933 { # A rule to be applied in a Policy. 934 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 935 { # Specifies what kind of log the caller must write 936 "counter": { # Options for counters # Counter options. 937 "field": "A String", # The field value to attribute. 938 "metric": "A String", # The metric to update. 939 }, 940 }, 941 ], 942 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 943 "A String", 944 ], 945 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 946 "A String", 947 ], 948 "action": "A String", # Required 949 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 950 "A String", 951 ], 952 "conditions": [ # Additional restrictions that must be met 953 { # A condition to be met. 954 "iam": "A String", # Trusted attributes supplied by the IAM system. 955 "svc": "A String", # Trusted attributes discharged by the service. 956 "value": "A String", # DEPRECATED. Use 'values' instead. 957 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 958 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 959 "A String", 960 ], 961 "op": "A String", # An operator to apply the subject with. 962 }, 963 ], 964 "description": "A String", # Human-readable description of the rule. 965 }, 966 ], 967 "version": 42, # Version of the `Policy`. The default version is 0. 968 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. 969 # 970 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 971 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 972 { # Associates `members` with a `role`. 973 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 974 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 975 # 976 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 977 # 978 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 979 # 980 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice (a] gmail.com` or `joe (a] example.com`. 981 # 982 # 983 # 984 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app (a] appspot.gserviceaccount.com`. 985 # 986 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins (a] example.com`. 987 # 988 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 989 "A String", 990 ], 991 }, 992 ], 993 "iamOwned": True or False, 994 } 995 996 997 Returns: 998 An object of the form: 999 1000 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 1001 # 1002 # 1003 # 1004 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 1005 # 1006 # **Example** 1007 # 1008 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike (a] example.com", "group:admins (a] example.com", "domain:google.com", "serviceAccount:my-other-app (a] appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean (a] example.com"] } ] } 1009 # 1010 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 1011 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1012 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. 1013 # 1014 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. 1015 # 1016 # Example Policy with multiple AuditConfigs: 1017 # 1018 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar (a] gmail.com" ] } ] } ] } 1019 # 1020 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo (a] gmail.com from DATA_READ logging, and bar (a] gmail.com from DATA_WRITE logging. 1021 "exemptedMembers": [ 1022 "A String", 1023 ], 1024 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1025 { # Provides the configuration for logging a type of permissions. Example: 1026 # 1027 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 1028 # 1029 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo (a] gmail.com from DATA_READ logging. 1030 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 1031 "A String", 1032 ], 1033 "logType": "A String", # The log type that this config enables. 1034 }, 1035 ], 1036 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 1037 }, 1038 ], 1039 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 1040 { # A rule to be applied in a Policy. 1041 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 1042 { # Specifies what kind of log the caller must write 1043 "counter": { # Options for counters # Counter options. 1044 "field": "A String", # The field value to attribute. 1045 "metric": "A String", # The metric to update. 1046 }, 1047 }, 1048 ], 1049 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 1050 "A String", 1051 ], 1052 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 1053 "A String", 1054 ], 1055 "action": "A String", # Required 1056 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 1057 "A String", 1058 ], 1059 "conditions": [ # Additional restrictions that must be met 1060 { # A condition to be met. 1061 "iam": "A String", # Trusted attributes supplied by the IAM system. 1062 "svc": "A String", # Trusted attributes discharged by the service. 1063 "value": "A String", # DEPRECATED. Use 'values' instead. 1064 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 1065 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 1066 "A String", 1067 ], 1068 "op": "A String", # An operator to apply the subject with. 1069 }, 1070 ], 1071 "description": "A String", # Human-readable description of the rule. 1072 }, 1073 ], 1074 "version": 42, # Version of the `Policy`. The default version is 0. 1075 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. 1076 # 1077 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 1078 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 1079 { # Associates `members` with a `role`. 1080 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1081 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 1082 # 1083 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 1084 # 1085 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1086 # 1087 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice (a] gmail.com` or `joe (a] example.com`. 1088 # 1089 # 1090 # 1091 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app (a] appspot.gserviceaccount.com`. 1092 # 1093 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins (a] example.com`. 1094 # 1095 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 1096 "A String", 1097 ], 1098 }, 1099 ], 1100 "iamOwned": True or False, 1101 }</pre> 1102 </div> 1103 1104 <div class="method"> 1105 <code class="details" id="stop">stop(project, deployment, body)</code> 1106 <pre>Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started. 1107 1108 Args: 1109 project: string, The project ID for this request. (required) 1110 deployment: string, The name of the deployment for this request. (required) 1111 body: object, The request body. (required) 1112 The object takes the form of: 1113 1114 { 1115 "fingerprint": "A String", # Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision). 1116 # 1117 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. 1118 } 1119 1120 1121 Returns: 1122 An object of the form: 1123 1124 { # An Operation resource, used to manage asynchronous API requests. 1125 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1126 "clientOperationId": "A String", # [Output Only] Reserved for future use. 1127 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1128 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1129 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 1130 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1131 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1132 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1133 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 1134 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 1135 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1136 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1137 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1138 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1139 { 1140 "message": "A String", # [Output Only] A human-readable description of the warning code. 1141 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 1142 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1143 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1144 { 1145 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1146 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 1147 }, 1148 ], 1149 }, 1150 ], 1151 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 1152 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1153 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1154 "name": "A String", # [Output Only] Name of the resource. 1155 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 1156 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1157 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1158 { 1159 "message": "A String", # [Output Only] An optional, human-readable error message. 1160 "code": "A String", # [Output Only] The error type identifier for this error. 1161 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1162 }, 1163 ], 1164 }, 1165 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1166 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1167 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 1168 }</pre> 1169 </div> 1170 1171 <div class="method"> 1172 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 1173 <pre>Returns permissions that a caller has on the specified resource. 1174 1175 Args: 1176 project: string, Project ID for this request. (required) 1177 resource: string, Name of the resource for this request. (required) 1178 body: object, The request body. (required) 1179 The object takes the form of: 1180 1181 { 1182 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1183 "A String", 1184 ], 1185 } 1186 1187 1188 Returns: 1189 An object of the form: 1190 1191 { 1192 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1193 "A String", 1194 ], 1195 }</pre> 1196 </div> 1197 1198 <div class="method"> 1199 <code class="details" id="update">update(project, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</code> 1200 <pre>Updates a deployment and all of the resources described by the deployment manifest. 1201 1202 Args: 1203 project: string, The project ID for this request. (required) 1204 deployment: string, The name of the deployment for this request. (required) 1205 body: object, The request body. (required) 1206 The object takes the form of: 1207 1208 { 1209 "description": "A String", # An optional user-provided description of the deployment. 1210 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? 1211 { 1212 "value": "A String", 1213 "key": "A String", 1214 }, 1215 ], 1216 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. 1217 "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? 1218 { 1219 "value": "A String", 1220 "key": "A String", 1221 }, 1222 ], 1223 "description": "A String", # [Output Only] An optional user-provided description of the deployment after the current update has been applied. 1224 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment. 1225 }, 1226 "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed. 1227 "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format . 1228 "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. 1229 # 1230 # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. 1231 "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment. 1232 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1233 "clientOperationId": "A String", # [Output Only] Reserved for future use. 1234 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1235 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1236 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 1237 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1238 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1239 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1240 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 1241 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 1242 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1243 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1244 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1245 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1246 { 1247 "message": "A String", # [Output Only] A human-readable description of the warning code. 1248 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 1249 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1250 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1251 { 1252 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1253 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 1254 }, 1255 ], 1256 }, 1257 ], 1258 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 1259 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1260 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1261 "name": "A String", # [Output Only] Name of the resource. 1262 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 1263 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1264 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1265 { 1266 "message": "A String", # [Output Only] An optional, human-readable error message. 1267 "code": "A String", # [Output Only] The error type identifier for this error. 1268 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1269 }, 1270 ], 1271 }, 1272 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1273 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1274 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 1275 }, 1276 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. 1277 "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. 1278 { 1279 "content": "A String", # The contents of the file. 1280 "name": "A String", # The name of the file. 1281 }, 1282 ], 1283 "config": { # The configuration to use for this deployment. 1284 "content": "A String", # The contents of the file. 1285 }, 1286 }, 1287 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 1288 "selfLink": "A String", # [Output Only] Self link for the deployment. 1289 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 1290 } 1291 1292 deletePolicy: string, Sets the policy to use for deleting resources. 1293 Allowed values 1294 ABANDON - 1295 DELETE - 1296 createPolicy: string, Sets the policy to use for creating new resources. 1297 Allowed values 1298 ACQUIRE - 1299 CREATE_OR_ACQUIRE - 1300 preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. 1301 1302 Returns: 1303 An object of the form: 1304 1305 { # An Operation resource, used to manage asynchronous API requests. 1306 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1307 "clientOperationId": "A String", # [Output Only] Reserved for future use. 1308 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1309 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1310 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 1311 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1312 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1313 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1314 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 1315 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 1316 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1317 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1318 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1319 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1320 { 1321 "message": "A String", # [Output Only] A human-readable description of the warning code. 1322 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 1323 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1324 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1325 { 1326 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1327 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 1328 }, 1329 ], 1330 }, 1331 ], 1332 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 1333 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1334 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1335 "name": "A String", # [Output Only] Name of the resource. 1336 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 1337 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1338 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1339 { 1340 "message": "A String", # [Output Only] An optional, human-readable error message. 1341 "code": "A String", # [Output Only] The error type identifier for this error. 1342 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1343 }, 1344 ], 1345 }, 1346 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1347 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1348 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 1349 }</pre> 1350 </div> 1351 1352 </body></html>
