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