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