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