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.compositeTypes.html">compositeTypes</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, compositeType, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a composite type.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, compositeType, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets information about a specific composite type.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(project, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Creates a composite type.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists all composite types for Deployment Manager.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(project, compositeType, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Patches a composite type.</p> 98<p class="toc_element"> 99 <code><a href="#update">update(project, compositeType, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates a composite type.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="delete">delete(project, compositeType, x__xgafv=None)</code> 109 <pre>Deletes a composite type. 110 111Args: 112 project: string, The project ID for this request. (required) 113 compositeType: string, The name of the type for this request. (required) 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118 119Returns: 120 An object of the form: 121 122 { # 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. 123 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 124 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 125 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 126 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 127 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 128 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 129 { 130 "code": "A String", # [Output Only] The error type identifier for this error. 131 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 132 "message": "A String", # [Output Only] An optional, human-readable error message. 133 }, 134 ], 135 }, 136 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 137 "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. 138 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 139 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 140 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 141 "name": "A String", # [Output Only] Name of the operation. 142 "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. 143 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 144 "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. 145 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 146 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 147 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 148 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 149 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 150 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 151 "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. 152 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. 153 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 154 { 155 "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. 156 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 157 { 158 "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). 159 "value": "A String", # [Output Only] A warning data value corresponding to the key. 160 }, 161 ], 162 "message": "A String", # [Output Only] A human-readable description of the warning code. 163 }, 164 ], 165 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 166}</pre> 167</div> 168 169<div class="method"> 170 <code class="details" id="get">get(project, compositeType, x__xgafv=None)</code> 171 <pre>Gets information about a specific composite type. 172 173Args: 174 project: string, The project ID for this request. (required) 175 compositeType: string, The name of the composite type for this request. (required) 176 x__xgafv: string, V1 error format. 177 Allowed values 178 1 - v1 error format 179 2 - v2 error format 180 181Returns: 182 An object of the form: 183 184 { # Holds the composite type. 185 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 186 "id": "A String", 187 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 188 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. 189 { # Label object for CompositeTypes 190 "key": "A String", # Key of the label 191 "value": "A String", # Value of the label 192 }, 193 ], 194 "name": "A String", # Name of the composite type, must follow the expression: `[a-z]([-a-z0-9_.]{0,61}[a-z0-9])?`. 195 "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 composite type. 196 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 197 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 198 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 199 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 200 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 201 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 202 { 203 "code": "A String", # [Output Only] The error type identifier for this error. 204 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 205 "message": "A String", # [Output Only] An optional, human-readable error message. 206 }, 207 ], 208 }, 209 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 210 "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. 211 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 212 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 213 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 214 "name": "A String", # [Output Only] Name of the operation. 215 "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. 216 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 217 "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. 218 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 219 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 220 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 221 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 222 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 223 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 224 "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. 225 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. 226 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 227 { 228 "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. 229 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 230 { 231 "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). 232 "value": "A String", # [Output Only] A warning data value corresponding to the key. 233 }, 234 ], 235 "message": "A String", # [Output Only] A human-readable description of the warning code. 236 }, 237 ], 238 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 239 }, 240 "selfLink": "A String", # Output only. Server defined URL for the resource. 241 "status": "A String", 242 "templateContents": { # Files that make up the template contents of a template type. # Files for the template type. 243 "imports": [ # Import files referenced by the main template. 244 { 245 "content": "A String", # The contents of the file. 246 "name": "A String", # The name of the file. 247 }, 248 ], 249 "interpreter": "A String", # Which interpreter (python or jinja) should be used during expansion. 250 "mainTemplate": "A String", # The filename of the mainTemplate 251 "schema": "A String", # The contents of the template schema. 252 "template": "A String", # The contents of the main template file. 253 }, 254}</pre> 255</div> 256 257<div class="method"> 258 <code class="details" id="insert">insert(project, body=None, x__xgafv=None)</code> 259 <pre>Creates a composite type. 260 261Args: 262 project: string, The project ID for this request. (required) 263 body: object, The request body. 264 The object takes the form of: 265 266{ # Holds the composite type. 267 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 268 "id": "A String", 269 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 270 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. 271 { # Label object for CompositeTypes 272 "key": "A String", # Key of the label 273 "value": "A String", # Value of the label 274 }, 275 ], 276 "name": "A String", # Name of the composite type, must follow the expression: `[a-z]([-a-z0-9_.]{0,61}[a-z0-9])?`. 277 "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 composite type. 278 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 279 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 280 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 281 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 282 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 283 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 284 { 285 "code": "A String", # [Output Only] The error type identifier for this error. 286 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 287 "message": "A String", # [Output Only] An optional, human-readable error message. 288 }, 289 ], 290 }, 291 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 292 "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. 293 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 294 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 295 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 296 "name": "A String", # [Output Only] Name of the operation. 297 "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. 298 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 299 "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. 300 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 301 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 302 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 303 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 304 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 305 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 306 "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. 307 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. 308 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 309 { 310 "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. 311 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 312 { 313 "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). 314 "value": "A String", # [Output Only] A warning data value corresponding to the key. 315 }, 316 ], 317 "message": "A String", # [Output Only] A human-readable description of the warning code. 318 }, 319 ], 320 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 321 }, 322 "selfLink": "A String", # Output only. Server defined URL for the resource. 323 "status": "A String", 324 "templateContents": { # Files that make up the template contents of a template type. # Files for the template type. 325 "imports": [ # Import files referenced by the main template. 326 { 327 "content": "A String", # The contents of the file. 328 "name": "A String", # The name of the file. 329 }, 330 ], 331 "interpreter": "A String", # Which interpreter (python or jinja) should be used during expansion. 332 "mainTemplate": "A String", # The filename of the mainTemplate 333 "schema": "A String", # The contents of the template schema. 334 "template": "A String", # The contents of the main template file. 335 }, 336} 337 338 x__xgafv: string, V1 error format. 339 Allowed values 340 1 - v1 error format 341 2 - v2 error format 342 343Returns: 344 An object of the form: 345 346 { # 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. 347 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 348 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 349 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 350 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 351 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 352 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 353 { 354 "code": "A String", # [Output Only] The error type identifier for this error. 355 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 356 "message": "A String", # [Output Only] An optional, human-readable error message. 357 }, 358 ], 359 }, 360 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 361 "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. 362 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 363 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 364 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 365 "name": "A String", # [Output Only] Name of the operation. 366 "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. 367 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 368 "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. 369 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 370 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 371 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 372 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 373 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 374 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 375 "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. 376 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. 377 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 378 { 379 "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. 380 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 381 { 382 "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). 383 "value": "A String", # [Output Only] A warning data value corresponding to the key. 384 }, 385 ], 386 "message": "A String", # [Output Only] A human-readable description of the warning code. 387 }, 388 ], 389 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 390}</pre> 391</div> 392 393<div class="method"> 394 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</code> 395 <pre>Lists all composite types for Deployment Manager. 396 397Args: 398 project: string, The project ID for this request. (required) 399 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) ``` 400 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`) 401 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. 402 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. 403 x__xgafv: string, V1 error format. 404 Allowed values 405 1 - v1 error format 406 2 - v2 error format 407 408Returns: 409 An object of the form: 410 411 { # A response that returns all Composite Types supported by Deployment Manager 412 "compositeTypes": [ # Output only. A list of resource composite types supported by Deployment Manager. 413 { # Holds the composite type. 414 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 415 "id": "A String", 416 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 417 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. 418 { # Label object for CompositeTypes 419 "key": "A String", # Key of the label 420 "value": "A String", # Value of the label 421 }, 422 ], 423 "name": "A String", # Name of the composite type, must follow the expression: `[a-z]([-a-z0-9_.]{0,61}[a-z0-9])?`. 424 "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 composite type. 425 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 426 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 427 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 428 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 429 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 430 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 431 { 432 "code": "A String", # [Output Only] The error type identifier for this error. 433 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 434 "message": "A String", # [Output Only] An optional, human-readable error message. 435 }, 436 ], 437 }, 438 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 439 "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. 440 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 441 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 442 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 443 "name": "A String", # [Output Only] Name of the operation. 444 "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. 445 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 446 "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. 447 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 448 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 449 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 450 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 451 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 452 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 453 "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. 454 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. 455 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 456 { 457 "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. 458 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 459 { 460 "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). 461 "value": "A String", # [Output Only] A warning data value corresponding to the key. 462 }, 463 ], 464 "message": "A String", # [Output Only] A human-readable description of the warning code. 465 }, 466 ], 467 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 468 }, 469 "selfLink": "A String", # Output only. Server defined URL for the resource. 470 "status": "A String", 471 "templateContents": { # Files that make up the template contents of a template type. # Files for the template type. 472 "imports": [ # Import files referenced by the main template. 473 { 474 "content": "A String", # The contents of the file. 475 "name": "A String", # The name of the file. 476 }, 477 ], 478 "interpreter": "A String", # Which interpreter (python or jinja) should be used during expansion. 479 "mainTemplate": "A String", # The filename of the mainTemplate 480 "schema": "A String", # The contents of the template schema. 481 "template": "A String", # The contents of the main template file. 482 }, 483 }, 484 ], 485 "nextPageToken": "A String", # A token used to continue a truncated list request. 486}</pre> 487</div> 488 489<div class="method"> 490 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 491 <pre>Retrieves the next page of results. 492 493Args: 494 previous_request: The request for the previous page. (required) 495 previous_response: The response from the request for the previous page. (required) 496 497Returns: 498 A request object that you can call 'execute()' on to request the next 499 page. Returns None if there are no more items in the collection. 500 </pre> 501</div> 502 503<div class="method"> 504 <code class="details" id="patch">patch(project, compositeType, body=None, x__xgafv=None)</code> 505 <pre>Patches a composite type. 506 507Args: 508 project: string, The project ID for this request. (required) 509 compositeType: string, The name of the composite type for this request. (required) 510 body: object, The request body. 511 The object takes the form of: 512 513{ # Holds the composite type. 514 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 515 "id": "A String", 516 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 517 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. 518 { # Label object for CompositeTypes 519 "key": "A String", # Key of the label 520 "value": "A String", # Value of the label 521 }, 522 ], 523 "name": "A String", # Name of the composite type, must follow the expression: `[a-z]([-a-z0-9_.]{0,61}[a-z0-9])?`. 524 "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 composite type. 525 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 526 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 527 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 528 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 529 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 530 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 531 { 532 "code": "A String", # [Output Only] The error type identifier for this error. 533 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 534 "message": "A String", # [Output Only] An optional, human-readable error message. 535 }, 536 ], 537 }, 538 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 539 "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. 540 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 541 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 542 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 543 "name": "A String", # [Output Only] Name of the operation. 544 "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. 545 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 546 "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. 547 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 548 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 549 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 550 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 551 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 552 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 553 "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. 554 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. 555 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 556 { 557 "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. 558 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 559 { 560 "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). 561 "value": "A String", # [Output Only] A warning data value corresponding to the key. 562 }, 563 ], 564 "message": "A String", # [Output Only] A human-readable description of the warning code. 565 }, 566 ], 567 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 568 }, 569 "selfLink": "A String", # Output only. Server defined URL for the resource. 570 "status": "A String", 571 "templateContents": { # Files that make up the template contents of a template type. # Files for the template type. 572 "imports": [ # Import files referenced by the main template. 573 { 574 "content": "A String", # The contents of the file. 575 "name": "A String", # The name of the file. 576 }, 577 ], 578 "interpreter": "A String", # Which interpreter (python or jinja) should be used during expansion. 579 "mainTemplate": "A String", # The filename of the mainTemplate 580 "schema": "A String", # The contents of the template schema. 581 "template": "A String", # The contents of the main template file. 582 }, 583} 584 585 x__xgafv: string, V1 error format. 586 Allowed values 587 1 - v1 error format 588 2 - v2 error format 589 590Returns: 591 An object of the form: 592 593 { # 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. 594 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 595 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 596 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 597 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 598 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 599 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 600 { 601 "code": "A String", # [Output Only] The error type identifier for this error. 602 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 603 "message": "A String", # [Output Only] An optional, human-readable error message. 604 }, 605 ], 606 }, 607 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 608 "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. 609 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 610 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 611 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 612 "name": "A String", # [Output Only] Name of the operation. 613 "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. 614 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 615 "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. 616 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 617 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 618 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 619 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 620 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 621 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 622 "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. 623 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. 624 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 625 { 626 "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. 627 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 628 { 629 "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). 630 "value": "A String", # [Output Only] A warning data value corresponding to the key. 631 }, 632 ], 633 "message": "A String", # [Output Only] A human-readable description of the warning code. 634 }, 635 ], 636 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 637}</pre> 638</div> 639 640<div class="method"> 641 <code class="details" id="update">update(project, compositeType, body=None, x__xgafv=None)</code> 642 <pre>Updates a composite type. 643 644Args: 645 project: string, The project ID for this request. (required) 646 compositeType: string, The name of the composite type for this request. (required) 647 body: object, The request body. 648 The object takes the form of: 649 650{ # Holds the composite type. 651 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 652 "id": "A String", 653 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 654 "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. 655 { # Label object for CompositeTypes 656 "key": "A String", # Key of the label 657 "value": "A String", # Value of the label 658 }, 659 ], 660 "name": "A String", # Name of the composite type, must follow the expression: `[a-z]([-a-z0-9_.]{0,61}[a-z0-9])?`. 661 "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 composite type. 662 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 663 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 664 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 665 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 666 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 667 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 668 { 669 "code": "A String", # [Output Only] The error type identifier for this error. 670 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 671 "message": "A String", # [Output Only] An optional, human-readable error message. 672 }, 673 ], 674 }, 675 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 676 "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. 677 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 678 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 679 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 680 "name": "A String", # [Output Only] Name of the operation. 681 "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. 682 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 683 "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. 684 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 685 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 686 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 687 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 688 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 689 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 690 "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. 691 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. 692 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 693 { 694 "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. 695 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 696 { 697 "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). 698 "value": "A String", # [Output Only] A warning data value corresponding to the key. 699 }, 700 ], 701 "message": "A String", # [Output Only] A human-readable description of the warning code. 702 }, 703 ], 704 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 705 }, 706 "selfLink": "A String", # Output only. Server defined URL for the resource. 707 "status": "A String", 708 "templateContents": { # Files that make up the template contents of a template type. # Files for the template type. 709 "imports": [ # Import files referenced by the main template. 710 { 711 "content": "A String", # The contents of the file. 712 "name": "A String", # The name of the file. 713 }, 714 ], 715 "interpreter": "A String", # Which interpreter (python or jinja) should be used during expansion. 716 "mainTemplate": "A String", # The filename of the mainTemplate 717 "schema": "A String", # The contents of the template schema. 718 "template": "A String", # The contents of the main template file. 719 }, 720} 721 722 x__xgafv: string, V1 error format. 723 Allowed values 724 1 - v1 error format 725 2 - v2 error format 726 727Returns: 728 An object of the form: 729 730 { # 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. 731 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 732 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 733 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 734 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 735 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 736 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 737 { 738 "code": "A String", # [Output Only] The error type identifier for this error. 739 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 740 "message": "A String", # [Output Only] An optional, human-readable error message. 741 }, 742 ], 743 }, 744 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 745 "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. 746 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 747 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 748 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 749 "name": "A String", # [Output Only] Name of the operation. 750 "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. 751 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 752 "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. 753 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 754 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 755 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 756 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 757 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 758 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 759 "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. 760 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. 761 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 762 { 763 "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. 764 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 765 { 766 "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). 767 "value": "A String", # [Output Only] A warning data value corresponding to the key. 768 }, 769 ], 770 "message": "A String", # [Output Only] A human-readable description of the warning code. 771 }, 772 ], 773 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 774}</pre> 775</div> 776 777</body></html>