1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="deploymentmanager_alpha.html">Google Cloud Deployment Manager Alpha API</a> . <a href="deploymentmanager_alpha.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 "nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed. 226 }, 227 "collectionOverrides": [ # Allows resource handling overrides for specific collections 228 { # CollectionOverride allows resource handling overrides for specific resources within a BaseType 229 "methodMap": { # Deployment Manager will call these methods during the events of creation/deletion/update/get/setIamPolicy # Custom verb method mappings to support unordered list API mappings. 230 "create": "A String", # The action identifier for the create method to be used for this collection 231 "get": "A String", # The action identifier for the get method to be used for this collection 232 "update": "A String", # The action identifier for the update method to be used for this collection 233 "setIamPolicy": "A String", # The action identifier for the setIamPolicy method to be used for this collection 234 "delete": "A String", # The action identifier for the delete method to be used for this collection 235 }, 236 "collection": "A String", # The collection that identifies this resource within its service. 237 "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override 238 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 239 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 240 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 241 }, 242 "asyncOptions": [ # Options regarding how to thread async requests. 243 { # Async options that determine when a resource should finish. 244 "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. 245 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 246 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 247 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 248 "failCondition": "A String", # JsonPath expression that determines if the request failed. 249 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 250 { 251 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 252 "level": "A String", # Level to record this diagnostic. 253 }, 254 ], 255 }, 256 "methodMatch": "A String", # Method regex where this policy will apply. 257 }, 258 ], 259 "inputMappings": [ # The mappings that apply for requests. 260 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 261 "fieldName": "A String", # The name of the field that is going to be injected. 262 "location": "A String", # The location where this mapping applies. 263 "value": "A String", # A jsonPath expression to select an element. 264 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 265 }, 266 ], 267 "nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed. 268 }, 269 }, 270 ], 271 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 272 "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. 273 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 274 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 275 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 276 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 277 "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. 278 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 279 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 280 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 281 "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. 282 "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. 283 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 284 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 285 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 286 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 287 { 288 "message": "A String", # [Output Only] A human-readable description of the warning code. 289 "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. 290 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 291 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 292 { 293 "value": "A String", # [Output Only] A warning data value corresponding to the key. 294 "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). 295 }, 296 ], 297 }, 298 ], 299 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 300 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 301 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 302 "name": "A String", # [Output Only] Name of the resource. 303 "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. 304 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 305 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 306 { 307 "message": "A String", # [Output Only] An optional, human-readable error message. 308 "code": "A String", # [Output Only] The error type identifier for this error. 309 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 310 }, 311 ], 312 }, 313 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 314 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 315 "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. 316 }, 317 "descriptorUrl": "A String", # Descriptor Url for the this type provider. 318 "id": "A String", # Output only. Unique identifier for the resource defined by the server. 319 "selfLink": "A String", # Output only. Self link for the type provider. 320 "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. 321 }</pre> 322</div> 323 324<div class="method"> 325 <code class="details" id="getType">getType(project, typeProvider, type)</code> 326 <pre>Gets a type info for a type provided by a TypeProvider. 327 328Args: 329 project: string, The project ID for this request. (required) 330 typeProvider: string, The name of the type provider for this request. (required) 331 type: string, The name of the type provider type for this request. (required) 332 333Returns: 334 An object of the form: 335 336 { # Type Information. Contains detailed information about a composite type, base type, or base type with specific collection. 337 "kind": "A String", # Output only. Type of the output. Always deploymentManager#TypeInfo for TypeInfo. 338 "description": "A String", # The description of the type. 339 "title": "A String", # The title on the API descriptor URL provided. 340 "name": "A String", # The base type or composite type name. 341 "documentationLink": "A String", # For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field will be empty. 342 "selfLink": "A String", # Output only. Self link for the type provider. 343 "schema": { # For base types with a collection, we return a schema and documentation link For template types, we return only a schema 344 "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 345 "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 346 }, 347 }</pre> 348</div> 349 350<div class="method"> 351 <code class="details" id="insert">insert(project, body)</code> 352 <pre>Creates a type provider. 353 354Args: 355 project: string, The project ID for this request. (required) 356 body: object, The request body. (required) 357 The object takes the form of: 358 359{ # A type provider that describes a service-backed Type. 360 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Credential used when interacting with this type. 361 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 362 "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com 363 }, 364 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 365 "password": "A String", 366 "user": "A String", 367 }, 368 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 369 }, 370 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 371 "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])?)? 372 { 373 "value": "A String", 374 "key": "A String", 375 }, 376 ], 377 "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service. 378 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 379 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 380 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 381 }, 382 "asyncOptions": [ # Options regarding how to thread async requests. 383 { # Async options that determine when a resource should finish. 384 "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. 385 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 386 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 387 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 388 "failCondition": "A String", # JsonPath expression that determines if the request failed. 389 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 390 { 391 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 392 "level": "A String", # Level to record this diagnostic. 393 }, 394 ], 395 }, 396 "methodMatch": "A String", # Method regex where this policy will apply. 397 }, 398 ], 399 "inputMappings": [ # The mappings that apply for requests. 400 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 401 "fieldName": "A String", # The name of the field that is going to be injected. 402 "location": "A String", # The location where this mapping applies. 403 "value": "A String", # A jsonPath expression to select an element. 404 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 405 }, 406 ], 407 "nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed. 408 }, 409 "collectionOverrides": [ # Allows resource handling overrides for specific collections 410 { # CollectionOverride allows resource handling overrides for specific resources within a BaseType 411 "methodMap": { # Deployment Manager will call these methods during the events of creation/deletion/update/get/setIamPolicy # Custom verb method mappings to support unordered list API mappings. 412 "create": "A String", # The action identifier for the create method to be used for this collection 413 "get": "A String", # The action identifier for the get method to be used for this collection 414 "update": "A String", # The action identifier for the update method to be used for this collection 415 "setIamPolicy": "A String", # The action identifier for the setIamPolicy method to be used for this collection 416 "delete": "A String", # The action identifier for the delete method to be used for this collection 417 }, 418 "collection": "A String", # The collection that identifies this resource within its service. 419 "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override 420 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 421 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 422 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 423 }, 424 "asyncOptions": [ # Options regarding how to thread async requests. 425 { # Async options that determine when a resource should finish. 426 "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. 427 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 428 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 429 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 430 "failCondition": "A String", # JsonPath expression that determines if the request failed. 431 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 432 { 433 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 434 "level": "A String", # Level to record this diagnostic. 435 }, 436 ], 437 }, 438 "methodMatch": "A String", # Method regex where this policy will apply. 439 }, 440 ], 441 "inputMappings": [ # The mappings that apply for requests. 442 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 443 "fieldName": "A String", # The name of the field that is going to be injected. 444 "location": "A String", # The location where this mapping applies. 445 "value": "A String", # A jsonPath expression to select an element. 446 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 447 }, 448 ], 449 "nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed. 450 }, 451 }, 452 ], 453 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 454 "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. 455 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 456 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 457 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 458 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 459 "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. 460 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 461 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 462 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 463 "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. 464 "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. 465 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 466 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 467 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 468 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 469 { 470 "message": "A String", # [Output Only] A human-readable description of the warning code. 471 "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. 472 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 473 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 474 { 475 "value": "A String", # [Output Only] A warning data value corresponding to the key. 476 "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). 477 }, 478 ], 479 }, 480 ], 481 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 482 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 483 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 484 "name": "A String", # [Output Only] Name of the resource. 485 "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. 486 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 487 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 488 { 489 "message": "A String", # [Output Only] An optional, human-readable error message. 490 "code": "A String", # [Output Only] The error type identifier for this error. 491 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 492 }, 493 ], 494 }, 495 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 496 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 497 "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. 498 }, 499 "descriptorUrl": "A String", # Descriptor Url for the this type provider. 500 "id": "A String", # Output only. Unique identifier for the resource defined by the server. 501 "selfLink": "A String", # Output only. Self link for the type provider. 502 "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. 503 } 504 505 506Returns: 507 An object of the form: 508 509 { # 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 ==) 510 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 511 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 512 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 513 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 514 "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. 515 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 516 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 517 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 518 "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. 519 "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. 520 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 521 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 522 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 523 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 524 { 525 "message": "A String", # [Output Only] A human-readable description of the warning code. 526 "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. 527 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 528 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 529 { 530 "value": "A String", # [Output Only] A warning data value corresponding to the key. 531 "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). 532 }, 533 ], 534 }, 535 ], 536 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 537 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 538 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 539 "name": "A String", # [Output Only] Name of the resource. 540 "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. 541 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 542 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 543 { 544 "message": "A String", # [Output Only] An optional, human-readable error message. 545 "code": "A String", # [Output Only] The error type identifier for this error. 546 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 547 }, 548 ], 549 }, 550 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 551 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 552 "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. 553 }</pre> 554</div> 555 556<div class="method"> 557 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 558 <pre>Lists all resource type providers for Deployment Manager. 559 560Args: 561 project: string, The project ID for this request. (required) 562 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 563 564You 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. 565 566Currently, only sorting by name or creationTimestamp desc is supported. 567 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) 568 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. 569 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 <. 570 571For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 572 573You 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. 574 575To 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). 576 577Returns: 578 An object of the form: 579 580 { # A response that returns all Type Providers supported by Deployment Manager 581 "nextPageToken": "A String", # A token used to continue a truncated list request. 582 "typeProviders": [ # Output only. A list of resource type providers supported by Deployment Manager. 583 { # A type provider that describes a service-backed Type. 584 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Credential used when interacting with this type. 585 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 586 "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com 587 }, 588 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 589 "password": "A String", 590 "user": "A String", 591 }, 592 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 593 }, 594 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 595 "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])?)? 596 { 597 "value": "A String", 598 "key": "A String", 599 }, 600 ], 601 "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service. 602 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 603 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 604 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 605 }, 606 "asyncOptions": [ # Options regarding how to thread async requests. 607 { # Async options that determine when a resource should finish. 608 "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. 609 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 610 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 611 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 612 "failCondition": "A String", # JsonPath expression that determines if the request failed. 613 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 614 { 615 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 616 "level": "A String", # Level to record this diagnostic. 617 }, 618 ], 619 }, 620 "methodMatch": "A String", # Method regex where this policy will apply. 621 }, 622 ], 623 "inputMappings": [ # The mappings that apply for requests. 624 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 625 "fieldName": "A String", # The name of the field that is going to be injected. 626 "location": "A String", # The location where this mapping applies. 627 "value": "A String", # A jsonPath expression to select an element. 628 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 629 }, 630 ], 631 "nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed. 632 }, 633 "collectionOverrides": [ # Allows resource handling overrides for specific collections 634 { # CollectionOverride allows resource handling overrides for specific resources within a BaseType 635 "methodMap": { # Deployment Manager will call these methods during the events of creation/deletion/update/get/setIamPolicy # Custom verb method mappings to support unordered list API mappings. 636 "create": "A String", # The action identifier for the create method to be used for this collection 637 "get": "A String", # The action identifier for the get method to be used for this collection 638 "update": "A String", # The action identifier for the update method to be used for this collection 639 "setIamPolicy": "A String", # The action identifier for the setIamPolicy method to be used for this collection 640 "delete": "A String", # The action identifier for the delete method to be used for this collection 641 }, 642 "collection": "A String", # The collection that identifies this resource within its service. 643 "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override 644 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 645 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 646 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 647 }, 648 "asyncOptions": [ # Options regarding how to thread async requests. 649 { # Async options that determine when a resource should finish. 650 "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. 651 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 652 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 653 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 654 "failCondition": "A String", # JsonPath expression that determines if the request failed. 655 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 656 { 657 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 658 "level": "A String", # Level to record this diagnostic. 659 }, 660 ], 661 }, 662 "methodMatch": "A String", # Method regex where this policy will apply. 663 }, 664 ], 665 "inputMappings": [ # The mappings that apply for requests. 666 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 667 "fieldName": "A String", # The name of the field that is going to be injected. 668 "location": "A String", # The location where this mapping applies. 669 "value": "A String", # A jsonPath expression to select an element. 670 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 671 }, 672 ], 673 "nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed. 674 }, 675 }, 676 ], 677 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 678 "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. 679 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 680 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 681 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 682 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 683 "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. 684 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 685 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 686 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 687 "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. 688 "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. 689 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 690 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 691 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 692 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 693 { 694 "message": "A String", # [Output Only] A human-readable description of the warning code. 695 "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. 696 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 697 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 698 { 699 "value": "A String", # [Output Only] A warning data value corresponding to the key. 700 "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). 701 }, 702 ], 703 }, 704 ], 705 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 706 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 707 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 708 "name": "A String", # [Output Only] Name of the resource. 709 "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. 710 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 711 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 712 { 713 "message": "A String", # [Output Only] An optional, human-readable error message. 714 "code": "A String", # [Output Only] The error type identifier for this error. 715 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 716 }, 717 ], 718 }, 719 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 720 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 721 "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. 722 }, 723 "descriptorUrl": "A String", # Descriptor Url for the this type provider. 724 "id": "A String", # Output only. Unique identifier for the resource defined by the server. 725 "selfLink": "A String", # Output only. Self link for the type provider. 726 "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. 727 }, 728 ], 729 }</pre> 730</div> 731 732<div class="method"> 733 <code class="details" id="listTypes">listTypes(project, typeProvider, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 734 <pre>Lists all the type info for a TypeProvider. 735 736Args: 737 project: string, The project ID for this request. (required) 738 typeProvider: string, The name of the type provider for this request. (required) 739 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 740 741You 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. 742 743Currently, only sorting by name or creationTimestamp desc is supported. 744 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) 745 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. 746 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 <. 747 748For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 749 750You 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. 751 752To 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). 753 754Returns: 755 An object of the form: 756 757 { 758 "nextPageToken": "A String", # A token used to continue a truncated list request. 759 "types": [ # Output only. A list of resource type info. 760 { # Type Information. Contains detailed information about a composite type, base type, or base type with specific collection. 761 "kind": "A String", # Output only. Type of the output. Always deploymentManager#TypeInfo for TypeInfo. 762 "description": "A String", # The description of the type. 763 "title": "A String", # The title on the API descriptor URL provided. 764 "name": "A String", # The base type or composite type name. 765 "documentationLink": "A String", # For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field will be empty. 766 "selfLink": "A String", # Output only. Self link for the type provider. 767 "schema": { # For base types with a collection, we return a schema and documentation link For template types, we return only a schema 768 "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 769 "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 770 }, 771 }, 772 ], 773 }</pre> 774</div> 775 776<div class="method"> 777 <code class="details" id="listTypes_next">listTypes_next(previous_request, previous_response)</code> 778 <pre>Retrieves the next page of results. 779 780Args: 781 previous_request: The request for the previous page. (required) 782 previous_response: The response from the request for the previous page. (required) 783 784Returns: 785 A request object that you can call 'execute()' on to request the next 786 page. Returns None if there are no more items in the collection. 787 </pre> 788</div> 789 790<div class="method"> 791 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 792 <pre>Retrieves the next page of results. 793 794Args: 795 previous_request: The request for the previous page. (required) 796 previous_response: The response from the request for the previous page. (required) 797 798Returns: 799 A request object that you can call 'execute()' on to request the next 800 page. Returns None if there are no more items in the collection. 801 </pre> 802</div> 803 804<div class="method"> 805 <code class="details" id="patch">patch(project, typeProvider, body)</code> 806 <pre>Updates a type provider. This method supports patch semantics. 807 808Args: 809 project: string, The project ID for this request. (required) 810 typeProvider: string, The name of the type provider for this request. (required) 811 body: object, The request body. (required) 812 The object takes the form of: 813 814{ # A type provider that describes a service-backed Type. 815 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Credential used when interacting with this type. 816 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 817 "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com 818 }, 819 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 820 "password": "A String", 821 "user": "A String", 822 }, 823 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 824 }, 825 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 826 "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])?)? 827 { 828 "value": "A String", 829 "key": "A String", 830 }, 831 ], 832 "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service. 833 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 834 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 835 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 836 }, 837 "asyncOptions": [ # Options regarding how to thread async requests. 838 { # Async options that determine when a resource should finish. 839 "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. 840 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 841 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 842 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 843 "failCondition": "A String", # JsonPath expression that determines if the request failed. 844 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 845 { 846 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 847 "level": "A String", # Level to record this diagnostic. 848 }, 849 ], 850 }, 851 "methodMatch": "A String", # Method regex where this policy will apply. 852 }, 853 ], 854 "inputMappings": [ # The mappings that apply for requests. 855 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 856 "fieldName": "A String", # The name of the field that is going to be injected. 857 "location": "A String", # The location where this mapping applies. 858 "value": "A String", # A jsonPath expression to select an element. 859 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 860 }, 861 ], 862 "nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed. 863 }, 864 "collectionOverrides": [ # Allows resource handling overrides for specific collections 865 { # CollectionOverride allows resource handling overrides for specific resources within a BaseType 866 "methodMap": { # Deployment Manager will call these methods during the events of creation/deletion/update/get/setIamPolicy # Custom verb method mappings to support unordered list API mappings. 867 "create": "A String", # The action identifier for the create method to be used for this collection 868 "get": "A String", # The action identifier for the get method to be used for this collection 869 "update": "A String", # The action identifier for the update method to be used for this collection 870 "setIamPolicy": "A String", # The action identifier for the setIamPolicy method to be used for this collection 871 "delete": "A String", # The action identifier for the delete method to be used for this collection 872 }, 873 "collection": "A String", # The collection that identifies this resource within its service. 874 "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override 875 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 876 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 877 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 878 }, 879 "asyncOptions": [ # Options regarding how to thread async requests. 880 { # Async options that determine when a resource should finish. 881 "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. 882 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 883 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 884 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 885 "failCondition": "A String", # JsonPath expression that determines if the request failed. 886 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 887 { 888 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 889 "level": "A String", # Level to record this diagnostic. 890 }, 891 ], 892 }, 893 "methodMatch": "A String", # Method regex where this policy will apply. 894 }, 895 ], 896 "inputMappings": [ # The mappings that apply for requests. 897 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 898 "fieldName": "A String", # The name of the field that is going to be injected. 899 "location": "A String", # The location where this mapping applies. 900 "value": "A String", # A jsonPath expression to select an element. 901 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 902 }, 903 ], 904 "nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed. 905 }, 906 }, 907 ], 908 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 909 "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. 910 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 911 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 912 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 913 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 914 "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. 915 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 916 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 917 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 918 "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. 919 "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. 920 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 921 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 922 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 923 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 924 { 925 "message": "A String", # [Output Only] A human-readable description of the warning code. 926 "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. 927 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 928 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 929 { 930 "value": "A String", # [Output Only] A warning data value corresponding to the key. 931 "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). 932 }, 933 ], 934 }, 935 ], 936 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 937 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 938 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 939 "name": "A String", # [Output Only] Name of the resource. 940 "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. 941 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 942 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 943 { 944 "message": "A String", # [Output Only] An optional, human-readable error message. 945 "code": "A String", # [Output Only] The error type identifier for this error. 946 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 947 }, 948 ], 949 }, 950 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 951 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 952 "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. 953 }, 954 "descriptorUrl": "A String", # Descriptor Url for the this type provider. 955 "id": "A String", # Output only. Unique identifier for the resource defined by the server. 956 "selfLink": "A String", # Output only. Self link for the type provider. 957 "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. 958 } 959 960 961Returns: 962 An object of the form: 963 964 { # 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 ==) 965 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 966 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 967 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 968 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 969 "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. 970 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 971 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 972 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 973 "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. 974 "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. 975 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 976 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 977 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 978 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 979 { 980 "message": "A String", # [Output Only] A human-readable description of the warning code. 981 "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. 982 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 983 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 984 { 985 "value": "A String", # [Output Only] A warning data value corresponding to the key. 986 "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). 987 }, 988 ], 989 }, 990 ], 991 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 992 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 993 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 994 "name": "A String", # [Output Only] Name of the resource. 995 "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. 996 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 997 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 998 { 999 "message": "A String", # [Output Only] An optional, human-readable error message. 1000 "code": "A String", # [Output Only] The error type identifier for this error. 1001 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1002 }, 1003 ], 1004 }, 1005 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1006 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1007 "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. 1008 }</pre> 1009</div> 1010 1011<div class="method"> 1012 <code class="details" id="update">update(project, typeProvider, body)</code> 1013 <pre>Updates a type provider. 1014 1015Args: 1016 project: string, The project ID for this request. (required) 1017 typeProvider: string, The name of the type provider for this request. (required) 1018 body: object, The request body. (required) 1019 The object takes the form of: 1020 1021{ # A type provider that describes a service-backed Type. 1022 "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Credential used when interacting with this type. 1023 "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment. 1024 "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com 1025 }, 1026 "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider. 1027 "password": "A String", 1028 "user": "A String", 1029 }, 1030 "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment. 1031 }, 1032 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 1033 "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])?)? 1034 { 1035 "value": "A String", 1036 "key": "A String", 1037 }, 1038 ], 1039 "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service. 1040 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 1041 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 1042 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 1043 }, 1044 "asyncOptions": [ # Options regarding how to thread async requests. 1045 { # Async options that determine when a resource should finish. 1046 "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. 1047 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 1048 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 1049 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 1050 "failCondition": "A String", # JsonPath expression that determines if the request failed. 1051 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 1052 { 1053 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 1054 "level": "A String", # Level to record this diagnostic. 1055 }, 1056 ], 1057 }, 1058 "methodMatch": "A String", # Method regex where this policy will apply. 1059 }, 1060 ], 1061 "inputMappings": [ # The mappings that apply for requests. 1062 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 1063 "fieldName": "A String", # The name of the field that is going to be injected. 1064 "location": "A String", # The location where this mapping applies. 1065 "value": "A String", # A jsonPath expression to select an element. 1066 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 1067 }, 1068 ], 1069 "nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed. 1070 }, 1071 "collectionOverrides": [ # Allows resource handling overrides for specific collections 1072 { # CollectionOverride allows resource handling overrides for specific resources within a BaseType 1073 "methodMap": { # Deployment Manager will call these methods during the events of creation/deletion/update/get/setIamPolicy # Custom verb method mappings to support unordered list API mappings. 1074 "create": "A String", # The action identifier for the create method to be used for this collection 1075 "get": "A String", # The action identifier for the get method to be used for this collection 1076 "update": "A String", # The action identifier for the update method to be used for this collection 1077 "setIamPolicy": "A String", # The action identifier for the setIamPolicy method to be used for this collection 1078 "delete": "A String", # The action identifier for the delete method to be used for this collection 1079 }, 1080 "collection": "A String", # The collection that identifies this resource within its service. 1081 "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override 1082 "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource. 1083 "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request. 1084 "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors. 1085 }, 1086 "asyncOptions": [ # Options regarding how to thread async requests. 1087 { # Async options that determine when a resource should finish. 1088 "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. 1089 "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource. 1090 "finishCondition": "A String", # JsonPath expression that determines if the request is completed. 1091 "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll. 1092 "failCondition": "A String", # JsonPath expression that determines if the request failed. 1093 "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user. 1094 { 1095 "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic. 1096 "level": "A String", # Level to record this diagnostic. 1097 }, 1098 ], 1099 }, 1100 "methodMatch": "A String", # Method regex where this policy will apply. 1101 }, 1102 ], 1103 "inputMappings": [ # The mappings that apply for requests. 1104 { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. 1105 "fieldName": "A String", # The name of the field that is going to be injected. 1106 "location": "A String", # The location where this mapping applies. 1107 "value": "A String", # A jsonPath expression to select an element. 1108 "methodMatch": "A String", # Regex to evaluate on method to decide if input applies. 1109 }, 1110 ], 1111 "nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed. 1112 }, 1113 }, 1114 ], 1115 "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. 1116 "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. 1117 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1118 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1119 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1120 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1121 "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. 1122 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1123 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1124 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1125 "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. 1126 "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. 1127 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1128 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1129 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1130 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1131 { 1132 "message": "A String", # [Output Only] A human-readable description of the warning code. 1133 "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. 1134 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1135 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1136 { 1137 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1138 "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). 1139 }, 1140 ], 1141 }, 1142 ], 1143 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1144 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1145 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1146 "name": "A String", # [Output Only] Name of the resource. 1147 "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. 1148 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1149 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1150 { 1151 "message": "A String", # [Output Only] An optional, human-readable error message. 1152 "code": "A String", # [Output Only] The error type identifier for this error. 1153 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1154 }, 1155 ], 1156 }, 1157 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1158 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1159 "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. 1160 }, 1161 "descriptorUrl": "A String", # Descriptor Url for the this type provider. 1162 "id": "A String", # Output only. Unique identifier for the resource defined by the server. 1163 "selfLink": "A String", # Output only. Self link for the type provider. 1164 "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. 1165 } 1166 1167 1168Returns: 1169 An object of the form: 1170 1171 { # 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 ==) 1172 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1173 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1174 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1175 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1176 "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. 1177 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1178 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1179 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1180 "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. 1181 "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. 1182 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1183 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1184 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1185 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1186 { 1187 "message": "A String", # [Output Only] A human-readable description of the warning code. 1188 "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. 1189 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1190 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1191 { 1192 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1193 "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). 1194 }, 1195 ], 1196 }, 1197 ], 1198 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1199 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1200 "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1201 "name": "A String", # [Output Only] Name of the resource. 1202 "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. 1203 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1204 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1205 { 1206 "message": "A String", # [Output Only] An optional, human-readable error message. 1207 "code": "A String", # [Output Only] The error type identifier for this error. 1208 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1209 }, 1210 ], 1211 }, 1212 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1213 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1214 "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. 1215 }</pre> 1216</div> 1217 1218</body></html>