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_v2beta.html">Google Cloud Deployment Manager API V2Beta Methods</a> . <a href="deploymentmanager_v2beta.typeProviders.html">typeProviders</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#delete">delete(project, typeProvider)</a></code></p> 79<p class="firstline">Deletes a type provider.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(project, typeProvider)</a></code></p> 82<p class="firstline">Gets information about a specific type provider.</p> 83<p class="toc_element"> 84 <code><a href="#getType">getType(project, typeProvider, type)</a></code></p> 85<p class="firstline">Gets a type info for a type provided by a TypeProvider.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(project, body)</a></code></p> 88<p class="firstline">Creates a type provider.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 91<p class="firstline">Lists all resource type providers for Deployment Manager.</p> 92<p class="toc_element"> 93 <code><a href="#listTypes">listTypes(project, typeProvider, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 94<p class="firstline">Lists all the type info for a TypeProvider.</p> 95<p class="toc_element"> 96 <code><a href="#listTypes_next">listTypes_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#patch">patch(project, typeProvider, body)</a></code></p> 103<p class="firstline">Updates a type provider. This method supports patch semantics.</p> 104<p class="toc_element"> 105 <code><a href="#update">update(project, typeProvider, body)</a></code></p> 106<p class="firstline">Updates a type provider.</p> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="delete">delete(project, typeProvider)</code> 110 <pre>Deletes a type provider. 111 112Args: 113 project: string, The project ID for this request. (required) 114 typeProvider: string, The name of the type provider for this request. (required) 115 116Returns: 117 An object of the form: 118 119 { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 120 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 121 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 122 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 123 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 124 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 125 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 126 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 127 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 128 "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. 129 "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. 130 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 131 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 132 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 133 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 134 { 135 "message": "A String", # [Output Only] A human-readable description of the warning code. 136 "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. 137 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 138 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 139 { 140 "value": "A String", # [Output Only] A warning data value corresponding to the key. 141 "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). 142 }, 143 ], 144 }, 145 ], 146 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 147 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 148 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 149 "name": "A String", # [Output Only] Name of the resource. 150 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 151 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 152 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 153 { 154 "message": "A String", # [Output Only] An optional, human-readable error message. 155 "code": "A String", # [Output Only] The error type identifier for this error. 156 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 157 }, 158 ], 159 }, 160 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 161 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 162 "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. 163 }</pre> 164</div> 165 166<div class="method"> 167 <code class="details" id="get">get(project, typeProvider)</code> 168 <pre>Gets information about a specific type provider. 169 170Args: 171 project: string, The project ID for this request. (required) 172 typeProvider: string, The name of the type provider for this request. (required) 173 174Returns: 175 An object of the form: 176 177 { # A type provider that describes a service-backed Type. 178 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Credential used when interacting with this type. 179 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 180 "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com 181 }, 182 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 183 "password": "A String", 184 "user": "A String", 185 }, 186 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 187 }, 188 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 189 "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])?)? 190 { 191 "value": "A String", 192 "key": "A String", 193 }, 194 ], 195 "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service. 196 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 197 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 198 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 199 }, 200 "asyncOptions": [ # Options regarding how to thread async requests. 201 { # Async options that determine when a resource should finish. 202 "pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. 203 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 204 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 205 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 206 "failCondition": "A String", # JsonPath expression that determines if the request failed. 207 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 208 { 209 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 210 "level": "A String", # Level to record this diagnostic. 211 }, 212 ], 213 }, 214 "methodMatch": "A String", # Method regex where this policy will apply. 215 }, 216 ], 217 "inputMappings": [ # The mappings that apply for requests. 218 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 219 "fieldName": "A String", # The name of the field that is going to be injected. 220 "location": "A String", # The location where this mapping applies. 221 "value": "A String", # A jsonPath expression to select an element. 222 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 223 }, 224 ], 225 "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number 226 }, 227 "collectionOverrides": [ # Allows resource handling overrides for specific collections 228 { # CollectionOverride allows resource handling overrides for specific resources within a BaseType 229 "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override 230 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 231 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 232 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 233 }, 234 "asyncOptions": [ # Options regarding how to thread async requests. 235 { # Async options that determine when a resource should finish. 236 "pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. 237 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 238 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 239 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 240 "failCondition": "A String", # JsonPath expression that determines if the request failed. 241 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 242 { 243 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 244 "level": "A String", # Level to record this diagnostic. 245 }, 246 ], 247 }, 248 "methodMatch": "A String", # Method regex where this policy will apply. 249 }, 250 ], 251 "inputMappings": [ # The mappings that apply for requests. 252 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 253 "fieldName": "A String", # The name of the field that is going to be injected. 254 "location": "A String", # The location where this mapping applies. 255 "value": "A String", # A jsonPath expression to select an element. 256 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 257 }, 258 ], 259 "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number 260 }, 261 "collection": "A String", # The collection that identifies this resource within its service. 262 }, 263 ], 264 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 265 "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this type provider. 266 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 267 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 268 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 269 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 270 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 271 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 272 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 273 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 274 "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. 275 "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. 276 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 277 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 278 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 279 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 280 { 281 "message": "A String", # [Output Only] A human-readable description of the warning code. 282 "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. 283 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 284 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 285 { 286 "value": "A String", # [Output Only] A warning data value corresponding to the key. 287 "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). 288 }, 289 ], 290 }, 291 ], 292 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 293 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 294 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 295 "name": "A String", # [Output Only] Name of the resource. 296 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 297 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 298 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 299 { 300 "message": "A String", # [Output Only] An optional, human-readable error message. 301 "code": "A String", # [Output Only] The error type identifier for this error. 302 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 303 }, 304 ], 305 }, 306 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 307 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 308 "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. 309 }, 310 "descriptorUrl": "A String", # Descriptor Url for the this type provider. 311 "id": "A String", # Output only. Unique identifier for the resource defined by the server. 312 "selfLink": "A String", # Output only. Self link for the type provider. 313 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 314 }</pre> 315</div> 316 317<div class="method"> 318 <code class="details" id="getType">getType(project, typeProvider, type)</code> 319 <pre>Gets a type info for a type provided by a TypeProvider. 320 321Args: 322 project: string, The project ID for this request. (required) 323 typeProvider: string, The name of the type provider for this request. (required) 324 type: string, The name of the type provider type for this request. (required) 325 326Returns: 327 An object of the form: 328 329 { # Type Information. Contains detailed information about a composite type, base type, or base type with specific collection. 330 "kind": "A String", # Output only. Type of the output. Always deploymentManager#TypeInfo for TypeInfo. 331 "description": "A String", # The description of the type. 332 "title": "A String", # The title on the API descriptor URL provided. 333 "name": "A String", # The base type or composite type name. 334 "documentationLink": "A String", # For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field will be empty. 335 "selfLink": "A String", # Output only. Self link for the type provider. 336 "schema": { # For base types with a collection, we return a schema and documentation link For template types, we return only a schema 337 "input": "A String", # The properties that this composite type or base type collection accept as input, represented as a json blob, format is: JSON Schema Draft V4 338 "output": "A String", # The properties that this composite type or base type collection exposes as output, these properties can be used for references, represented as json blob, format is: JSON Schema Draft V4 339 }, 340 }</pre> 341</div> 342 343<div class="method"> 344 <code class="details" id="insert">insert(project, body)</code> 345 <pre>Creates a type provider. 346 347Args: 348 project: string, The project ID for this request. (required) 349 body: object, The request body. (required) 350 The object takes the form of: 351 352{ # A type provider that describes a service-backed Type. 353 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Credential used when interacting with this type. 354 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 355 "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com 356 }, 357 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 358 "password": "A String", 359 "user": "A String", 360 }, 361 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 362 }, 363 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 364 "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])?)? 365 { 366 "value": "A String", 367 "key": "A String", 368 }, 369 ], 370 "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service. 371 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 372 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 373 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 374 }, 375 "asyncOptions": [ # Options regarding how to thread async requests. 376 { # Async options that determine when a resource should finish. 377 "pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. 378 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 379 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 380 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 381 "failCondition": "A String", # JsonPath expression that determines if the request failed. 382 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 383 { 384 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 385 "level": "A String", # Level to record this diagnostic. 386 }, 387 ], 388 }, 389 "methodMatch": "A String", # Method regex where this policy will apply. 390 }, 391 ], 392 "inputMappings": [ # The mappings that apply for requests. 393 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 394 "fieldName": "A String", # The name of the field that is going to be injected. 395 "location": "A String", # The location where this mapping applies. 396 "value": "A String", # A jsonPath expression to select an element. 397 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 398 }, 399 ], 400 "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number 401 }, 402 "collectionOverrides": [ # Allows resource handling overrides for specific collections 403 { # CollectionOverride allows resource handling overrides for specific resources within a BaseType 404 "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override 405 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 406 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 407 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 408 }, 409 "asyncOptions": [ # Options regarding how to thread async requests. 410 { # Async options that determine when a resource should finish. 411 "pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. 412 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 413 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 414 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 415 "failCondition": "A String", # JsonPath expression that determines if the request failed. 416 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 417 { 418 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 419 "level": "A String", # Level to record this diagnostic. 420 }, 421 ], 422 }, 423 "methodMatch": "A String", # Method regex where this policy will apply. 424 }, 425 ], 426 "inputMappings": [ # The mappings that apply for requests. 427 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 428 "fieldName": "A String", # The name of the field that is going to be injected. 429 "location": "A String", # The location where this mapping applies. 430 "value": "A String", # A jsonPath expression to select an element. 431 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 432 }, 433 ], 434 "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number 435 }, 436 "collection": "A String", # The collection that identifies this resource within its service. 437 }, 438 ], 439 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 440 "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this type provider. 441 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 442 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 443 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 444 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 445 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 446 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 447 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 448 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 449 "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. 450 "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. 451 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 452 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 453 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 454 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 455 { 456 "message": "A String", # [Output Only] A human-readable description of the warning code. 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: 459 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 460 { 461 "value": "A String", # [Output Only] A warning data value corresponding to the key. 462 "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). 463 }, 464 ], 465 }, 466 ], 467 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 468 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 469 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 470 "name": "A String", # [Output Only] Name of the resource. 471 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 472 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 473 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 474 { 475 "message": "A String", # [Output Only] An optional, human-readable error message. 476 "code": "A String", # [Output Only] The error type identifier for this error. 477 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 478 }, 479 ], 480 }, 481 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 482 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 483 "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. 484 }, 485 "descriptorUrl": "A String", # Descriptor Url for the this type provider. 486 "id": "A String", # Output only. Unique identifier for the resource defined by the server. 487 "selfLink": "A String", # Output only. Self link for the type provider. 488 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 489 } 490 491 492Returns: 493 An object of the form: 494 495 { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 496 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 497 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 498 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 499 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 500 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 501 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 502 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 503 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 504 "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. 505 "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. 506 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 507 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 508 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 509 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 510 { 511 "message": "A String", # [Output Only] A human-readable description of the warning code. 512 "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. 513 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 514 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 515 { 516 "value": "A String", # [Output Only] A warning data value corresponding to the key. 517 "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). 518 }, 519 ], 520 }, 521 ], 522 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 523 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 524 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 525 "name": "A String", # [Output Only] Name of the resource. 526 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 527 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 528 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 529 { 530 "message": "A String", # [Output Only] An optional, human-readable error message. 531 "code": "A String", # [Output Only] The error type identifier for this error. 532 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 533 }, 534 ], 535 }, 536 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 537 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 538 "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. 539 }</pre> 540</div> 541 542<div class="method"> 543 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 544 <pre>Lists all resource type providers for Deployment Manager. 545 546Args: 547 project: string, The project ID for this request. (required) 548 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 549 550You 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. 551 552Currently, only sorting by name or creationTimestamp desc is supported. 553 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) 554 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. 555 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 556 557For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 558 559You 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. 560 561To 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). 562 563Returns: 564 An object of the form: 565 566 { # A response that returns all Type Providers supported by Deployment Manager 567 "nextPageToken": "A String", # A token used to continue a truncated list request. 568 "typeProviders": [ # Output only. A list of resource type providers supported by Deployment Manager. 569 { # A type provider that describes a service-backed Type. 570 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Credential used when interacting with this type. 571 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 572 "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com 573 }, 574 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 575 "password": "A String", 576 "user": "A String", 577 }, 578 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 579 }, 580 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 581 "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])?)? 582 { 583 "value": "A String", 584 "key": "A String", 585 }, 586 ], 587 "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service. 588 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 589 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 590 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 591 }, 592 "asyncOptions": [ # Options regarding how to thread async requests. 593 { # Async options that determine when a resource should finish. 594 "pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. 595 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 596 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 597 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 598 "failCondition": "A String", # JsonPath expression that determines if the request failed. 599 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 600 { 601 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 602 "level": "A String", # Level to record this diagnostic. 603 }, 604 ], 605 }, 606 "methodMatch": "A String", # Method regex where this policy will apply. 607 }, 608 ], 609 "inputMappings": [ # The mappings that apply for requests. 610 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 611 "fieldName": "A String", # The name of the field that is going to be injected. 612 "location": "A String", # The location where this mapping applies. 613 "value": "A String", # A jsonPath expression to select an element. 614 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 615 }, 616 ], 617 "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number 618 }, 619 "collectionOverrides": [ # Allows resource handling overrides for specific collections 620 { # CollectionOverride allows resource handling overrides for specific resources within a BaseType 621 "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override 622 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 623 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 624 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 625 }, 626 "asyncOptions": [ # Options regarding how to thread async requests. 627 { # Async options that determine when a resource should finish. 628 "pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. 629 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 630 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 631 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 632 "failCondition": "A String", # JsonPath expression that determines if the request failed. 633 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 634 { 635 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 636 "level": "A String", # Level to record this diagnostic. 637 }, 638 ], 639 }, 640 "methodMatch": "A String", # Method regex where this policy will apply. 641 }, 642 ], 643 "inputMappings": [ # The mappings that apply for requests. 644 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 645 "fieldName": "A String", # The name of the field that is going to be injected. 646 "location": "A String", # The location where this mapping applies. 647 "value": "A String", # A jsonPath expression to select an element. 648 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 649 }, 650 ], 651 "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number 652 }, 653 "collection": "A String", # The collection that identifies this resource within its service. 654 }, 655 ], 656 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 657 "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this type provider. 658 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 659 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 660 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 661 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 662 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 663 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 664 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 665 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 666 "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. 667 "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. 668 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 669 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 670 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 671 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 672 { 673 "message": "A String", # [Output Only] A human-readable description of the warning code. 674 "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. 675 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 676 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 677 { 678 "value": "A String", # [Output Only] A warning data value corresponding to the key. 679 "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). 680 }, 681 ], 682 }, 683 ], 684 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 685 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 686 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 687 "name": "A String", # [Output Only] Name of the resource. 688 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 689 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 690 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 691 { 692 "message": "A String", # [Output Only] An optional, human-readable error message. 693 "code": "A String", # [Output Only] The error type identifier for this error. 694 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 695 }, 696 ], 697 }, 698 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 699 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 700 "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. 701 }, 702 "descriptorUrl": "A String", # Descriptor Url for the this type provider. 703 "id": "A String", # Output only. Unique identifier for the resource defined by the server. 704 "selfLink": "A String", # Output only. Self link for the type provider. 705 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 706 }, 707 ], 708 }</pre> 709</div> 710 711<div class="method"> 712 <code class="details" id="listTypes">listTypes(project, typeProvider, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 713 <pre>Lists all the type info for a TypeProvider. 714 715Args: 716 project: string, The project ID for this request. (required) 717 typeProvider: string, The name of the type provider for this request. (required) 718 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 719 720You 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. 721 722Currently, only sorting by name or creationTimestamp desc is supported. 723 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) 724 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. 725 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 726 727For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 728 729You 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. 730 731To 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). 732 733Returns: 734 An object of the form: 735 736 { 737 "nextPageToken": "A String", # A token used to continue a truncated list request. 738 "types": [ # Output only. A list of resource type info. 739 { # Type Information. Contains detailed information about a composite type, base type, or base type with specific collection. 740 "kind": "A String", # Output only. Type of the output. Always deploymentManager#TypeInfo for TypeInfo. 741 "description": "A String", # The description of the type. 742 "title": "A String", # The title on the API descriptor URL provided. 743 "name": "A String", # The base type or composite type name. 744 "documentationLink": "A String", # For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field will be empty. 745 "selfLink": "A String", # Output only. Self link for the type provider. 746 "schema": { # For base types with a collection, we return a schema and documentation link For template types, we return only a schema 747 "input": "A String", # The properties that this composite type or base type collection accept as input, represented as a json blob, format is: JSON Schema Draft V4 748 "output": "A String", # The properties that this composite type or base type collection exposes as output, these properties can be used for references, represented as json blob, format is: JSON Schema Draft V4 749 }, 750 }, 751 ], 752 }</pre> 753</div> 754 755<div class="method"> 756 <code class="details" id="listTypes_next">listTypes_next(previous_request, previous_response)</code> 757 <pre>Retrieves the next page of results. 758 759Args: 760 previous_request: The request for the previous page. (required) 761 previous_response: The response from the request for the previous page. (required) 762 763Returns: 764 A request object that you can call 'execute()' on to request the next 765 page. Returns None if there are no more items in the collection. 766 </pre> 767</div> 768 769<div class="method"> 770 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 771 <pre>Retrieves the next page of results. 772 773Args: 774 previous_request: The request for the previous page. (required) 775 previous_response: The response from the request for the previous page. (required) 776 777Returns: 778 A request object that you can call 'execute()' on to request the next 779 page. Returns None if there are no more items in the collection. 780 </pre> 781</div> 782 783<div class="method"> 784 <code class="details" id="patch">patch(project, typeProvider, body)</code> 785 <pre>Updates a type provider. This method supports patch semantics. 786 787Args: 788 project: string, The project ID for this request. (required) 789 typeProvider: string, The name of the type provider for this request. (required) 790 body: object, The request body. (required) 791 The object takes the form of: 792 793{ # A type provider that describes a service-backed Type. 794 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Credential used when interacting with this type. 795 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 796 "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com 797 }, 798 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 799 "password": "A String", 800 "user": "A String", 801 }, 802 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 803 }, 804 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 805 "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])?)? 806 { 807 "value": "A String", 808 "key": "A String", 809 }, 810 ], 811 "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service. 812 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 813 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 814 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 815 }, 816 "asyncOptions": [ # Options regarding how to thread async requests. 817 { # Async options that determine when a resource should finish. 818 "pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. 819 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 820 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 821 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 822 "failCondition": "A String", # JsonPath expression that determines if the request failed. 823 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 824 { 825 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 826 "level": "A String", # Level to record this diagnostic. 827 }, 828 ], 829 }, 830 "methodMatch": "A String", # Method regex where this policy will apply. 831 }, 832 ], 833 "inputMappings": [ # The mappings that apply for requests. 834 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 835 "fieldName": "A String", # The name of the field that is going to be injected. 836 "location": "A String", # The location where this mapping applies. 837 "value": "A String", # A jsonPath expression to select an element. 838 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 839 }, 840 ], 841 "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number 842 }, 843 "collectionOverrides": [ # Allows resource handling overrides for specific collections 844 { # CollectionOverride allows resource handling overrides for specific resources within a BaseType 845 "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override 846 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 847 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 848 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 849 }, 850 "asyncOptions": [ # Options regarding how to thread async requests. 851 { # Async options that determine when a resource should finish. 852 "pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. 853 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 854 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 855 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 856 "failCondition": "A String", # JsonPath expression that determines if the request failed. 857 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 858 { 859 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 860 "level": "A String", # Level to record this diagnostic. 861 }, 862 ], 863 }, 864 "methodMatch": "A String", # Method regex where this policy will apply. 865 }, 866 ], 867 "inputMappings": [ # The mappings that apply for requests. 868 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 869 "fieldName": "A String", # The name of the field that is going to be injected. 870 "location": "A String", # The location where this mapping applies. 871 "value": "A String", # A jsonPath expression to select an element. 872 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 873 }, 874 ], 875 "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number 876 }, 877 "collection": "A String", # The collection that identifies this resource within its service. 878 }, 879 ], 880 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 881 "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this type provider. 882 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 883 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 884 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 885 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 886 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 887 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 888 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 889 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 890 "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. 891 "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. 892 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 893 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 894 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 895 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 896 { 897 "message": "A String", # [Output Only] A human-readable description of the warning code. 898 "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. 899 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 900 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 901 { 902 "value": "A String", # [Output Only] A warning data value corresponding to the key. 903 "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). 904 }, 905 ], 906 }, 907 ], 908 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 909 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 910 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 911 "name": "A String", # [Output Only] Name of the resource. 912 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 913 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 914 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 915 { 916 "message": "A String", # [Output Only] An optional, human-readable error message. 917 "code": "A String", # [Output Only] The error type identifier for this error. 918 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 919 }, 920 ], 921 }, 922 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 923 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 924 "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. 925 }, 926 "descriptorUrl": "A String", # Descriptor Url for the this type provider. 927 "id": "A String", # Output only. Unique identifier for the resource defined by the server. 928 "selfLink": "A String", # Output only. Self link for the type provider. 929 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 930 } 931 932 933Returns: 934 An object of the form: 935 936 { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 937 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 938 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 939 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 940 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 941 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 942 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 943 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 944 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 945 "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. 946 "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. 947 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 948 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 949 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 950 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 951 { 952 "message": "A String", # [Output Only] A human-readable description of the warning code. 953 "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. 954 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 955 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 956 { 957 "value": "A String", # [Output Only] A warning data value corresponding to the key. 958 "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). 959 }, 960 ], 961 }, 962 ], 963 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 964 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 965 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 966 "name": "A String", # [Output Only] Name of the resource. 967 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 968 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 969 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 970 { 971 "message": "A String", # [Output Only] An optional, human-readable error message. 972 "code": "A String", # [Output Only] The error type identifier for this error. 973 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 974 }, 975 ], 976 }, 977 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 978 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 979 "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. 980 }</pre> 981</div> 982 983<div class="method"> 984 <code class="details" id="update">update(project, typeProvider, body)</code> 985 <pre>Updates a type provider. 986 987Args: 988 project: string, The project ID for this request. (required) 989 typeProvider: string, The name of the type provider for this request. (required) 990 body: object, The request body. (required) 991 The object takes the form of: 992 993{ # A type provider that describes a service-backed Type. 994 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Credential used when interacting with this type. 995 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 996 "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com 997 }, 998 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 999 "password": "A String", 1000 "user": "A String", 1001 }, 1002 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 1003 }, 1004 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 1005 "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])?)? 1006 { 1007 "value": "A String", 1008 "key": "A String", 1009 }, 1010 ], 1011 "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service. 1012 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 1013 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 1014 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 1015 }, 1016 "asyncOptions": [ # Options regarding how to thread async requests. 1017 { # Async options that determine when a resource should finish. 1018 "pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. 1019 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 1020 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 1021 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 1022 "failCondition": "A String", # JsonPath expression that determines if the request failed. 1023 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 1024 { 1025 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 1026 "level": "A String", # Level to record this diagnostic. 1027 }, 1028 ], 1029 }, 1030 "methodMatch": "A String", # Method regex where this policy will apply. 1031 }, 1032 ], 1033 "inputMappings": [ # The mappings that apply for requests. 1034 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 1035 "fieldName": "A String", # The name of the field that is going to be injected. 1036 "location": "A String", # The location where this mapping applies. 1037 "value": "A String", # A jsonPath expression to select an element. 1038 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 1039 }, 1040 ], 1041 "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number 1042 }, 1043 "collectionOverrides": [ # Allows resource handling overrides for specific collections 1044 { # CollectionOverride allows resource handling overrides for specific resources within a BaseType 1045 "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override 1046 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 1047 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 1048 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 1049 }, 1050 "asyncOptions": [ # Options regarding how to thread async requests. 1051 { # Async options that determine when a resource should finish. 1052 "pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed. 1053 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 1054 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 1055 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 1056 "failCondition": "A String", # JsonPath expression that determines if the request failed. 1057 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 1058 { 1059 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 1060 "level": "A String", # Level to record this diagnostic. 1061 }, 1062 ], 1063 }, 1064 "methodMatch": "A String", # Method regex where this policy will apply. 1065 }, 1066 ], 1067 "inputMappings": [ # The mappings that apply for requests. 1068 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 1069 "fieldName": "A String", # The name of the field that is going to be injected. 1070 "location": "A String", # The location where this mapping applies. 1071 "value": "A String", # A jsonPath expression to select an element. 1072 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 1073 }, 1074 ], 1075 "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number 1076 }, 1077 "collection": "A String", # The collection that identifies this resource within its service. 1078 }, 1079 ], 1080 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 1081 "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this type provider. 1082 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1083 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1084 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1085 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1086 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 1087 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1088 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1089 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1090 "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. 1091 "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. 1092 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1093 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1094 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1095 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1096 { 1097 "message": "A String", # [Output Only] A human-readable description of the warning code. 1098 "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. 1099 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1100 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1101 { 1102 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1103 "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). 1104 }, 1105 ], 1106 }, 1107 ], 1108 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1109 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1110 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1111 "name": "A String", # [Output Only] Name of the resource. 1112 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 1113 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1114 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1115 { 1116 "message": "A String", # [Output Only] An optional, human-readable error message. 1117 "code": "A String", # [Output Only] The error type identifier for this error. 1118 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1119 }, 1120 ], 1121 }, 1122 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1123 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1124 "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. 1125 }, 1126 "descriptorUrl": "A String", # Descriptor Url for the this type provider. 1127 "id": "A String", # Output only. Unique identifier for the resource defined by the server. 1128 "selfLink": "A String", # Output only. Self link for the type provider. 1129 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 1130 } 1131 1132 1133Returns: 1134 An object of the form: 1135 1136 { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 1137 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1138 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1139 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1140 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1141 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 1142 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1143 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1144 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1145 "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. 1146 "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. 1147 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1148 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1149 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1150 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1151 { 1152 "message": "A String", # [Output Only] A human-readable description of the warning code. 1153 "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. 1154 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1155 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1156 { 1157 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1158 "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). 1159 }, 1160 ], 1161 }, 1162 ], 1163 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1164 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1165 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1166 "name": "A String", # [Output Only] Name of the resource. 1167 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 1168 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1169 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1170 { 1171 "message": "A String", # [Output Only] An optional, human-readable error message. 1172 "code": "A String", # [Output Only] The error type identifier for this error. 1173 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1174 }, 1175 ], 1176 }, 1177 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1178 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1179 "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. 1180 }</pre> 1181</div> 1182 1183</body></html>