1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="deploymentmanager_alpha.html">Cloud Deployment Manager V2 API</a> . <a href="deploymentmanager_alpha.deployments.html">deployments</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#cancelPreview">cancelPreview(project, deployment, body=None, x__xgafv=None)</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="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(project, deployment, deletePolicy=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a deployment and all of the resources in the deployment.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(project, deployment, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets information about a specific deployment.</p> 89<p class="toc_element"> 90 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> 92<p class="toc_element"> 93 <code><a href="#insert">insert(project, body=None, createPolicy=None, preview=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Creates a deployment and all of the resources described by the deployment manifest.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Lists all deployments for a given project.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#patch">patch(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Patches a deployment and all of the resources described by the deployment manifest.</p> 104<p class="toc_element"> 105 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 107<p class="toc_element"> 108 <code><a href="#stop">stop(project, deployment, body=None, x__xgafv=None)</a></code></p> 109<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> 110<p class="toc_element"> 111 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 113<p class="toc_element"> 114 <code><a href="#update">update(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Updates a deployment and all of the resources described by the deployment manifest.</p> 116<h3>Method Details</h3> 117<div class="method"> 118 <code class="details" id="cancelPreview">cancelPreview(project, deployment, body=None, x__xgafv=None)</code> 119 <pre>Cancels and removes the preview currently associated with the deployment. 120 121Args: 122 project: string, The project ID for this request. (required) 123 deployment: string, The name of the deployment for this request. (required) 124 body: object, The request body. 125 The object takes the form of: 126 127{ 128 "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). 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. 129} 130 131 x__xgafv: string, V1 error format. 132 Allowed values 133 1 - v1 error format 134 2 - v2 error format 135 136Returns: 137 An object of the form: 138 139 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 140 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 141 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 142 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 143 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 144 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 145 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 146 { 147 "code": "A String", # [Output Only] The error type identifier for this error. 148 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 149 "message": "A String", # [Output Only] An optional, human-readable error message. 150 }, 151 ], 152 }, 153 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 154 "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. 155 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 156 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 157 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 158 "name": "A String", # [Output Only] Name of the operation. 159 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 160 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 161 "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. 162 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 163 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 164 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 165 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 166 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 167 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 168 "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. 169 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 170 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 171 { 172 "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. 173 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 174 { 175 "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). 176 "value": "A String", # [Output Only] A warning data value corresponding to the key. 177 }, 178 ], 179 "message": "A String", # [Output Only] A human-readable description of the warning code. 180 }, 181 ], 182 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 183}</pre> 184</div> 185 186<div class="method"> 187 <code class="details" id="close">close()</code> 188 <pre>Close httplib2 connections.</pre> 189</div> 190 191<div class="method"> 192 <code class="details" id="delete">delete(project, deployment, deletePolicy=None, x__xgafv=None)</code> 193 <pre>Deletes a deployment and all of the resources in the deployment. 194 195Args: 196 project: string, The project ID for this request. (required) 197 deployment: string, The name of the deployment for this request. (required) 198 deletePolicy: string, Sets the policy to use for deleting resources. 199 Allowed values 200 DELETE - 201 ABANDON - 202 x__xgafv: string, V1 error format. 203 Allowed values 204 1 - v1 error format 205 2 - v2 error format 206 207Returns: 208 An object of the form: 209 210 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 211 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 212 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 213 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 214 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 215 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 216 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 217 { 218 "code": "A String", # [Output Only] The error type identifier for this error. 219 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 220 "message": "A String", # [Output Only] An optional, human-readable error message. 221 }, 222 ], 223 }, 224 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 225 "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. 226 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 227 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 228 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 229 "name": "A String", # [Output Only] Name of the operation. 230 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 231 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 232 "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. 233 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 234 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 235 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 236 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 237 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 238 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target 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 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 241 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 242 { 243 "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. 244 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 245 { 246 "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). 247 "value": "A String", # [Output Only] A warning data value corresponding to the key. 248 }, 249 ], 250 "message": "A String", # [Output Only] A human-readable description of the warning code. 251 }, 252 ], 253 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 254}</pre> 255</div> 256 257<div class="method"> 258 <code class="details" id="get">get(project, deployment, x__xgafv=None)</code> 259 <pre>Gets information about a specific deployment. 260 261Args: 262 project: string, The project ID for this request. (required) 263 deployment: string, The name of the deployment for this request. (required) 264 x__xgafv: string, V1 error format. 265 Allowed values 266 1 - v1 error format 267 2 - v2 error format 268 269Returns: 270 An object of the form: 271 272 { 273 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # User provided default credential for the deployment. 274 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 275 "password": "A String", 276 "user": "A String", 277 }, 278 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 279 "email": "A String", # The IAM service account email address like [email protected] 280 }, 281 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 282 }, 283 "description": "A String", # An optional user-provided description of the deployment. 284 "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. 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. 285 "id": "A String", 286 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 287 "labels": [ # Map of One Platform 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])?)?`. 288 { # Label object for Deployments 289 "key": "A String", # Key of the label 290 "value": "A String", # Value of the label 291 }, 292 ], 293 "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent. 294 "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. 295 "operation": { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment. 296 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 297 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 298 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 299 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 300 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 301 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 302 { 303 "code": "A String", # [Output Only] The error type identifier for this error. 304 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 305 "message": "A String", # [Output Only] An optional, human-readable error message. 306 }, 307 ], 308 }, 309 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 310 "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. 311 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 312 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 313 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 314 "name": "A String", # [Output Only] Name of the operation. 315 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 316 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 317 "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. 318 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 319 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 320 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 321 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 322 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 323 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 324 "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. 325 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 326 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 327 { 328 "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. 329 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 330 { 331 "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). 332 "value": "A String", # [Output Only] A warning data value corresponding to the key. 333 }, 334 ], 335 "message": "A String", # [Output Only] A human-readable description of the warning code. 336 }, 337 ], 338 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 339 }, 340 "outputs": [ # Output only. List of outputs from the last manifest that deployed successfully. 341 { # Output object for Deployments 342 "key": "A String", # Key of the output 343 "value": "A String", # Value of the label 344 }, 345 ], 346 "selfLink": "A String", # Output only. Server defined URL for the resource. 347 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. 348 "config": { # The configuration to use for this deployment. 349 "content": "A String", # The contents of the file. 350 }, 351 "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. 352 { 353 "content": "A String", # The contents of the file. 354 "name": "A String", # The name of the file. 355 }, 356 ], 357 }, 358 "update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. 359 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The user-provided default credential to use when deploying this preview. 360 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 361 "password": "A String", 362 "user": "A String", 363 }, 364 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 365 "email": "A String", # The IAM service account email address like [email protected] 366 }, 367 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 368 }, 369 "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied. 370 "labels": [ # Map of One Platform 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])?)?`. 371 { # Label object for DeploymentUpdate 372 "key": "A String", # Key of the label 373 "value": "A String", # Value of the label 374 }, 375 ], 376 "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment. 377 }, 378 "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format. 379}</pre> 380</div> 381 382<div class="method"> 383 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code> 384 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 385 386Args: 387 project: string, Project ID for this request. (required) 388 resource: string, Name or id of the resource for this request. (required) 389 optionsRequestedPolicyVersion: integer, Requested IAM Policy version. 390 x__xgafv: string, V1 error format. 391 Allowed values 392 1 - v1 error format 393 2 - v2 error format 394 395Returns: 396 An object of the form: 397 398 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 399 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 400 { # 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. 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 AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 401 "auditLogConfigs": [ # The configuration for logging of each type of permission. 402 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 403 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 404 "A String", 405 ], 406 "logType": "A String", # The log type that this config enables. 407 }, 408 ], 409 "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. 410 }, 411 ], 412 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 413 { # Associates `members`, or principals, with a `role`. 414 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 415 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 416 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 417 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 418 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 419 }, 420 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 421 "A String", 422 ], 423 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 424 }, 425 ], 426 "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. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 427 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 428}</pre> 429</div> 430 431<div class="method"> 432 <code class="details" id="insert">insert(project, body=None, createPolicy=None, preview=None, x__xgafv=None)</code> 433 <pre>Creates a deployment and all of the resources described by the deployment manifest. 434 435Args: 436 project: string, The project ID for this request. (required) 437 body: object, The request body. 438 The object takes the form of: 439 440{ 441 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # User provided default credential for the deployment. 442 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 443 "password": "A String", 444 "user": "A String", 445 }, 446 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 447 "email": "A String", # The IAM service account email address like [email protected] 448 }, 449 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 450 }, 451 "description": "A String", # An optional user-provided description of the deployment. 452 "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. 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. 453 "id": "A String", 454 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 455 "labels": [ # Map of One Platform 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])?)?`. 456 { # Label object for Deployments 457 "key": "A String", # Key of the label 458 "value": "A String", # Value of the label 459 }, 460 ], 461 "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent. 462 "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. 463 "operation": { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment. 464 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 465 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 466 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 467 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 468 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 469 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 470 { 471 "code": "A String", # [Output Only] The error type identifier for this error. 472 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 473 "message": "A String", # [Output Only] An optional, human-readable error message. 474 }, 475 ], 476 }, 477 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 478 "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. 479 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 480 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 481 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 482 "name": "A String", # [Output Only] Name of the operation. 483 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 484 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 485 "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. 486 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 487 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 488 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 489 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 490 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 491 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 492 "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. 493 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 494 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 495 { 496 "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. 497 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 498 { 499 "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). 500 "value": "A String", # [Output Only] A warning data value corresponding to the key. 501 }, 502 ], 503 "message": "A String", # [Output Only] A human-readable description of the warning code. 504 }, 505 ], 506 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 507 }, 508 "outputs": [ # Output only. List of outputs from the last manifest that deployed successfully. 509 { # Output object for Deployments 510 "key": "A String", # Key of the output 511 "value": "A String", # Value of the label 512 }, 513 ], 514 "selfLink": "A String", # Output only. Server defined URL for the resource. 515 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. 516 "config": { # The configuration to use for this deployment. 517 "content": "A String", # The contents of the file. 518 }, 519 "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. 520 { 521 "content": "A String", # The contents of the file. 522 "name": "A String", # The name of the file. 523 }, 524 ], 525 }, 526 "update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. 527 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The user-provided default credential to use when deploying this preview. 528 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 529 "password": "A String", 530 "user": "A String", 531 }, 532 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 533 "email": "A String", # The IAM service account email address like [email protected] 534 }, 535 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 536 }, 537 "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied. 538 "labels": [ # Map of One Platform 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])?)?`. 539 { # Label object for DeploymentUpdate 540 "key": "A String", # Key of the label 541 "value": "A String", # Value of the label 542 }, 543 ], 544 "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment. 545 }, 546 "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format. 547} 548 549 createPolicy: string, Sets the policy to use for creating new resources. 550 Allowed values 551 CREATE_OR_ACQUIRE - 552 ACQUIRE - 553 CREATE - 554 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. 555 x__xgafv: string, V1 error format. 556 Allowed values 557 1 - v1 error format 558 2 - v2 error format 559 560Returns: 561 An object of the form: 562 563 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 564 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 565 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 566 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 567 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 568 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 569 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 570 { 571 "code": "A String", # [Output Only] The error type identifier for this error. 572 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 573 "message": "A String", # [Output Only] An optional, human-readable error message. 574 }, 575 ], 576 }, 577 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 578 "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. 579 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 580 "insertTime": "A String", # [Output Only] The time that this operation was requested. 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 operation. 583 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 584 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 585 "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. 586 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 587 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 588 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 589 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 590 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 591 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 592 "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. 593 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 594 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 595 { 596 "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. 597 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 598 { 599 "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). 600 "value": "A String", # [Output Only] A warning data value corresponding to the key. 601 }, 602 ], 603 "message": "A String", # [Output Only] A human-readable description of the warning code. 604 }, 605 ], 606 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 607}</pre> 608</div> 609 610<div class="method"> 611 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</code> 612 <pre>Lists all deployments for a given project. 613 614Args: 615 project: string, The project ID for this request. (required) 616 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 617 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`) 618 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 619 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. 620 x__xgafv: string, V1 error format. 621 Allowed values 622 1 - v1 error format 623 2 - v2 error format 624 625Returns: 626 An object of the form: 627 628 { # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated. 629 "deployments": [ # Output only. The deployments contained in this response. 630 { 631 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # User provided default credential for the deployment. 632 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 633 "password": "A String", 634 "user": "A String", 635 }, 636 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 637 "email": "A String", # The IAM service account email address like [email protected] 638 }, 639 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 640 }, 641 "description": "A String", # An optional user-provided description of the deployment. 642 "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. 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. 643 "id": "A String", 644 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 645 "labels": [ # Map of One Platform 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])?)?`. 646 { # Label object for Deployments 647 "key": "A String", # Key of the label 648 "value": "A String", # Value of the label 649 }, 650 ], 651 "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent. 652 "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. 653 "operation": { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment. 654 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 655 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 656 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 657 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 658 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 659 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 660 { 661 "code": "A String", # [Output Only] The error type identifier for this error. 662 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 663 "message": "A String", # [Output Only] An optional, human-readable error message. 664 }, 665 ], 666 }, 667 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 668 "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. 669 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 670 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 671 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 672 "name": "A String", # [Output Only] Name of the operation. 673 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 674 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 675 "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. 676 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 677 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 678 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 679 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 680 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 681 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 682 "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. 683 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 684 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 685 { 686 "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. 687 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 688 { 689 "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). 690 "value": "A String", # [Output Only] A warning data value corresponding to the key. 691 }, 692 ], 693 "message": "A String", # [Output Only] A human-readable description of the warning code. 694 }, 695 ], 696 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 697 }, 698 "outputs": [ # Output only. List of outputs from the last manifest that deployed successfully. 699 { # Output object for Deployments 700 "key": "A String", # Key of the output 701 "value": "A String", # Value of the label 702 }, 703 ], 704 "selfLink": "A String", # Output only. Server defined URL for the resource. 705 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. 706 "config": { # The configuration to use for this deployment. 707 "content": "A String", # The contents of the file. 708 }, 709 "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. 710 { 711 "content": "A String", # The contents of the file. 712 "name": "A String", # The name of the file. 713 }, 714 ], 715 }, 716 "update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. 717 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The user-provided default credential to use when deploying this preview. 718 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 719 "password": "A String", 720 "user": "A String", 721 }, 722 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 723 "email": "A String", # The IAM service account email address like [email protected] 724 }, 725 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 726 }, 727 "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied. 728 "labels": [ # Map of One Platform 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])?)?`. 729 { # Label object for DeploymentUpdate 730 "key": "A String", # Key of the label 731 "value": "A String", # Value of the label 732 }, 733 ], 734 "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment. 735 }, 736 "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format. 737 }, 738 ], 739 "nextPageToken": "A String", # Output only. A token used to continue a truncated list request. 740}</pre> 741</div> 742 743<div class="method"> 744 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 745 <pre>Retrieves the next page of results. 746 747Args: 748 previous_request: The request for the previous page. (required) 749 previous_response: The response from the request for the previous page. (required) 750 751Returns: 752 A request object that you can call 'execute()' on to request the next 753 page. Returns None if there are no more items in the collection. 754 </pre> 755</div> 756 757<div class="method"> 758 <code class="details" id="patch">patch(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None, x__xgafv=None)</code> 759 <pre>Patches a deployment and all of the resources described by the deployment manifest. 760 761Args: 762 project: string, The project ID for this request. (required) 763 deployment: string, The name of the deployment for this request. (required) 764 body: object, The request body. 765 The object takes the form of: 766 767{ 768 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # User provided default credential for the deployment. 769 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 770 "password": "A String", 771 "user": "A String", 772 }, 773 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 774 "email": "A String", # The IAM service account email address like [email protected] 775 }, 776 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 777 }, 778 "description": "A String", # An optional user-provided description of the deployment. 779 "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. 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. 780 "id": "A String", 781 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 782 "labels": [ # Map of One Platform 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])?)?`. 783 { # Label object for Deployments 784 "key": "A String", # Key of the label 785 "value": "A String", # Value of the label 786 }, 787 ], 788 "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent. 789 "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. 790 "operation": { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment. 791 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 792 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 793 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 794 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 795 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 796 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 797 { 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 "message": "A String", # [Output Only] An optional, human-readable error message. 801 }, 802 ], 803 }, 804 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 805 "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. 806 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 807 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 808 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 809 "name": "A String", # [Output Only] Name of the operation. 810 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 811 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 812 "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. 813 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 814 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 815 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 816 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 817 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 818 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 819 "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. 820 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 821 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 822 { 823 "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. 824 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 825 { 826 "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). 827 "value": "A String", # [Output Only] A warning data value corresponding to the key. 828 }, 829 ], 830 "message": "A String", # [Output Only] A human-readable description of the warning code. 831 }, 832 ], 833 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 834 }, 835 "outputs": [ # Output only. List of outputs from the last manifest that deployed successfully. 836 { # Output object for Deployments 837 "key": "A String", # Key of the output 838 "value": "A String", # Value of the label 839 }, 840 ], 841 "selfLink": "A String", # Output only. Server defined URL for the resource. 842 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. 843 "config": { # The configuration to use for this deployment. 844 "content": "A String", # The contents of the file. 845 }, 846 "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. 847 { 848 "content": "A String", # The contents of the file. 849 "name": "A String", # The name of the file. 850 }, 851 ], 852 }, 853 "update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. 854 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The user-provided default credential to use when deploying this preview. 855 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 856 "password": "A String", 857 "user": "A String", 858 }, 859 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 860 "email": "A String", # The IAM service account email address like [email protected] 861 }, 862 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 863 }, 864 "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied. 865 "labels": [ # Map of One Platform 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])?)?`. 866 { # Label object for DeploymentUpdate 867 "key": "A String", # Key of the label 868 "value": "A String", # Value of the label 869 }, 870 ], 871 "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment. 872 }, 873 "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format. 874} 875 876 createPolicy: string, Sets the policy to use for creating new resources. 877 Allowed values 878 CREATE_OR_ACQUIRE - 879 ACQUIRE - 880 CREATE - 881 deletePolicy: string, Sets the policy to use for deleting resources. 882 Allowed values 883 DELETE - 884 ABANDON - 885 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. 886 x__xgafv: string, V1 error format. 887 Allowed values 888 1 - v1 error format 889 2 - v2 error format 890 891Returns: 892 An object of the form: 893 894 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 895 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 896 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 897 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 898 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 899 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 900 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 901 { 902 "code": "A String", # [Output Only] The error type identifier for this error. 903 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 904 "message": "A String", # [Output Only] An optional, human-readable error message. 905 }, 906 ], 907 }, 908 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 909 "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. 910 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 911 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 912 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 913 "name": "A String", # [Output Only] Name of the operation. 914 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 915 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 916 "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. 917 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 918 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 919 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 920 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 921 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 922 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 923 "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. 924 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 925 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 926 { 927 "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. 928 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 929 { 930 "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). 931 "value": "A String", # [Output Only] A warning data value corresponding to the key. 932 }, 933 ], 934 "message": "A String", # [Output Only] A human-readable description of the warning code. 935 }, 936 ], 937 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 938}</pre> 939</div> 940 941<div class="method"> 942 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code> 943 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 944 945Args: 946 project: string, Project ID for this request. (required) 947 resource: string, Name or id of the resource for this request. (required) 948 body: object, The request body. 949 The object takes the form of: 950 951{ 952 "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. 953 { # Associates `members`, or principals, with a `role`. 954 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 955 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 956 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 957 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 958 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 959 }, 960 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 961 "A String", 962 ], 963 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 964 }, 965 ], 966 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. 967 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. 968 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 969 { # 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. 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 AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 970 "auditLogConfigs": [ # The configuration for logging of each type of permission. 971 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 972 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 973 "A String", 974 ], 975 "logType": "A String", # The log type that this config enables. 976 }, 977 ], 978 "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. 979 }, 980 ], 981 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 982 { # Associates `members`, or principals, with a `role`. 983 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 984 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 985 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 986 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 987 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 988 }, 989 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 990 "A String", 991 ], 992 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 993 }, 994 ], 995 "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. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 996 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 997 }, 998} 999 1000 x__xgafv: string, V1 error format. 1001 Allowed values 1002 1 - v1 error format 1003 2 - v2 error format 1004 1005Returns: 1006 An object of the form: 1007 1008 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 1009 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1010 { # 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. 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 AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 1011 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1012 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 1013 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 1014 "A String", 1015 ], 1016 "logType": "A String", # The log type that this config enables. 1017 }, 1018 ], 1019 "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. 1020 }, 1021 ], 1022 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 1023 { # Associates `members`, or principals, with a `role`. 1024 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1025 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1026 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1027 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1028 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 1029 }, 1030 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1031 "A String", 1032 ], 1033 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1034 }, 1035 ], 1036 "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. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 1037 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1038}</pre> 1039</div> 1040 1041<div class="method"> 1042 <code class="details" id="stop">stop(project, deployment, body=None, x__xgafv=None)</code> 1043 <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. 1044 1045Args: 1046 project: string, The project ID for this request. (required) 1047 deployment: string, The name of the deployment for this request. (required) 1048 body: object, The request body. 1049 The object takes the form of: 1050 1051{ 1052 "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). 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. 1053} 1054 1055 x__xgafv: string, V1 error format. 1056 Allowed values 1057 1 - v1 error format 1058 2 - v2 error format 1059 1060Returns: 1061 An object of the form: 1062 1063 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1064 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1065 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1066 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1067 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1068 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1069 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1070 { 1071 "code": "A String", # [Output Only] The error type identifier for this error. 1072 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1073 "message": "A String", # [Output Only] An optional, human-readable error message. 1074 }, 1075 ], 1076 }, 1077 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1078 "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. 1079 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1080 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1081 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1082 "name": "A String", # [Output Only] Name of the operation. 1083 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1084 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1085 "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. 1086 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1087 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1088 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1089 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1090 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1091 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1092 "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. 1093 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1094 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1095 { 1096 "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. 1097 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1098 { 1099 "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). 1100 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1101 }, 1102 ], 1103 "message": "A String", # [Output Only] A human-readable description of the warning code. 1104 }, 1105 ], 1106 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1107}</pre> 1108</div> 1109 1110<div class="method"> 1111 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> 1112 <pre>Returns permissions that a caller has on the specified resource. 1113 1114Args: 1115 project: string, Project ID for this request. (required) 1116 resource: string, Name or id of the resource for this request. (required) 1117 body: object, The request body. 1118 The object takes the form of: 1119 1120{ 1121 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1122 "A String", 1123 ], 1124} 1125 1126 x__xgafv: string, V1 error format. 1127 Allowed values 1128 1 - v1 error format 1129 2 - v2 error format 1130 1131Returns: 1132 An object of the form: 1133 1134 { 1135 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1136 "A String", 1137 ], 1138}</pre> 1139</div> 1140 1141<div class="method"> 1142 <code class="details" id="update">update(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None, x__xgafv=None)</code> 1143 <pre>Updates a deployment and all of the resources described by the deployment manifest. 1144 1145Args: 1146 project: string, The project ID for this request. (required) 1147 deployment: string, The name of the deployment for this request. (required) 1148 body: object, The request body. 1149 The object takes the form of: 1150 1151{ 1152 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # User provided default credential for the deployment. 1153 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 1154 "password": "A String", 1155 "user": "A String", 1156 }, 1157 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 1158 "email": "A String", # The IAM service account email address like [email protected] 1159 }, 1160 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 1161 }, 1162 "description": "A String", # An optional user-provided description of the deployment. 1163 "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. 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. 1164 "id": "A String", 1165 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 1166 "labels": [ # Map of One Platform 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])?)?`. 1167 { # Label object for Deployments 1168 "key": "A String", # Key of the label 1169 "value": "A String", # Value of the label 1170 }, 1171 ], 1172 "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent. 1173 "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. 1174 "operation": { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment. 1175 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1176 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1177 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1178 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1179 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1180 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1181 { 1182 "code": "A String", # [Output Only] The error type identifier for this error. 1183 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1184 "message": "A String", # [Output Only] An optional, human-readable error message. 1185 }, 1186 ], 1187 }, 1188 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1189 "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. 1190 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1191 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1192 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1193 "name": "A String", # [Output Only] Name of the operation. 1194 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1195 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1196 "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. 1197 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1198 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1199 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1200 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1201 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1202 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1203 "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. 1204 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1205 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1206 { 1207 "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. 1208 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1209 { 1210 "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). 1211 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1212 }, 1213 ], 1214 "message": "A String", # [Output Only] A human-readable description of the warning code. 1215 }, 1216 ], 1217 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1218 }, 1219 "outputs": [ # Output only. List of outputs from the last manifest that deployed successfully. 1220 { # Output object for Deployments 1221 "key": "A String", # Key of the output 1222 "value": "A String", # Value of the label 1223 }, 1224 ], 1225 "selfLink": "A String", # Output only. Server defined URL for the resource. 1226 "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. 1227 "config": { # The configuration to use for this deployment. 1228 "content": "A String", # The contents of the file. 1229 }, 1230 "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. 1231 { 1232 "content": "A String", # The contents of the file. 1233 "name": "A String", # The name of the file. 1234 }, 1235 ], 1236 }, 1237 "update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. 1238 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The user-provided default credential to use when deploying this preview. 1239 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 1240 "password": "A String", 1241 "user": "A String", 1242 }, 1243 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 1244 "email": "A String", # The IAM service account email address like [email protected] 1245 }, 1246 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 1247 }, 1248 "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied. 1249 "labels": [ # Map of One Platform 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])?)?`. 1250 { # Label object for DeploymentUpdate 1251 "key": "A String", # Key of the label 1252 "value": "A String", # Value of the label 1253 }, 1254 ], 1255 "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment. 1256 }, 1257 "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format. 1258} 1259 1260 createPolicy: string, Sets the policy to use for creating new resources. 1261 Allowed values 1262 CREATE_OR_ACQUIRE - 1263 ACQUIRE - 1264 CREATE - 1265 deletePolicy: string, Sets the policy to use for deleting resources. 1266 Allowed values 1267 DELETE - 1268 ABANDON - 1269 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. 1270 x__xgafv: string, V1 error format. 1271 Allowed values 1272 1 - v1 error format 1273 2 - v2 error format 1274 1275Returns: 1276 An object of the form: 1277 1278 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1279 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1280 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1281 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1282 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1283 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1284 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1285 { 1286 "code": "A String", # [Output Only] The error type identifier for this error. 1287 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1288 "message": "A String", # [Output Only] An optional, human-readable error message. 1289 }, 1290 ], 1291 }, 1292 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1293 "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. 1294 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1295 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1296 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1297 "name": "A String", # [Output Only] Name of the operation. 1298 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1299 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1300 "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. 1301 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1302 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1303 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1304 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1305 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1306 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1307 "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. 1308 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1309 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1310 { 1311 "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. 1312 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1313 { 1314 "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). 1315 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1316 }, 1317 ], 1318 "message": "A String", # [Output Only] A human-readable description of the warning code. 1319 }, 1320 ], 1321 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1322}</pre> 1323</div> 1324 1325</body></html>