Types

A Type represents a resource that can be deployed by Deployment Manager. For example, compute.v1.instance is a type. You can also register your own types. For more information, read more about Types.

For a list of methods for this resource, see the end of this page.

Resource representations

A resource type supported by Deployment Manager.

{
  "id": unsigned long,
  "selfLink": string,
  "insertTime": string,
  "name": string,
  "base": {
    "descriptorUrl": string,
    "credential": {
      "basicAuth": {
        "user": string,
        "password": string
      }
    },
    "options": {
      "inputMappings": [
        {
          "fieldName": string,
          "methodMatch": string,
          "value": string,
          "location": string
        }
      ],
      "validationOptions": {
        "undeclaredProperties": string,
        "schemaValidation": string
      },
      "virtualProperties": string
    },
    "collectionOverrides": [
      {
        "collection": string,
        "options": {
          "inputMappings": [
            {
              "fieldName": string,
              "methodMatch": string,
              "value": string,
              "location": string
            }
          ],
          "validationOptions": {
            "undeclaredProperties": string,
            "schemaValidation": string
          },
          "virtualProperties": string
        }
      }
    ]
  },
  "description": string,
  "operation": operations Resource,
  "labels": [
    {
      "key": string,
      "value": string
    }
  ]
}
Property name Value Description Notes
base nested object Base Type (configurable service) that backs this Type.
base.collectionOverrides[] list Allows resource handling overrides for specific collections
base.collectionOverrides[].collection string The collection that identifies this resource within its service.
base.collectionOverrides[].options nested object The options to apply to this resource-level override.
base.collectionOverrides[].options.inputMappings[] list The input mappings for requests.
base.collectionOverrides[].options.inputMappings[].fieldName string The name of the field that this input mapping applies to. For example, fingerprint.
base.collectionOverrides[].options.inputMappings[].location string The location where this mapping applies.
base.collectionOverrides[].options.inputMappings[].methodMatch string One or more API methods that this input mapping applies to. You can use regular expression to evaluate methods the applies. For example, 'methodMatch': '^(get|delete|put)$'.
base.collectionOverrides[].options.inputMappings[].value string A JSON path expression to select an element as the value of this field. For example, if you were creating an input mapping to say that the value of the fingerprint field can be found on the resource's fingerprint property, the expression for value would look like this:
$.resource.self.fingerprint
If you wanted to select a property provided by a user's Deployment Manager configuration, you can use:
$.resources.properties.name
For more information, read Specifying input mappings.
base.collectionOverrides[].options.validationOptions nested object Sets the options for how to validate properties on a resource.
base.collectionOverrides[].options.validationOptions.schemaValidation string Customize how deployment manager will validate the resource against schema errors.
base.collectionOverrides[].options.validationOptions.undeclaredProperties string Specify what to do with extra properties when executing a request.
base.collectionOverrides[].options.virtualProperties string Creates virtual properties described by JSON schema. These virtual properties will never be part of the API payload, but they can be consumed by input mappings. This must be a valid json schema draft-04.

This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by input mappings. For example:
"virtualProperties": "schema: http://json-schema.org/draft-04/schema#\ntype: object\nproperties:\n  [PROPERTY]:\n    type: [DATA_TYPE]\n  [ANOTHER_PROPERTY]:\n    type: [ANOTHER_DATA_TYPE]n"
base.credential nested object Credential used when interacting with this type.
base.credential.basicAuth nested object Basic Auth Credentials for this TypeProvider.
base.credential.basicAuth.password string
base.credential.basicAuth.user string
base.descriptorUrl string Descriptor Url for the this type.
base.options nested object Options to apply when handling any resources in this service.
base.options.inputMappings[] list The input mappings for requests.
base.options.inputMappings[].fieldName string The name of the field that this input mapping applies to. For example, fingerprint.
base.options.inputMappings[].location string The location where this mapping applies.
base.options.inputMappings[].methodMatch string One or more API methods that this input mapping applies to. You can use regular expression to evaluate methods the applies. For example, 'methodMatch': '^(get|delete|put)$'.
base.options.inputMappings[].value string A JSON path expression to select an element as the value of this field. For example, if you were creating an input mapping to say that the value of the fingerprint field can be found on the resource's fingerprint property, the expression for value would look like this:
$.resource.self.fingerprint
If you wanted to select a property provided by a user's Deployment Manager configuration, you can use:
$.resources.properties.name
For more information, read Specifying input mappings.
base.options.validationOptions nested object Sets the options for how to validate properties on a resource.
base.options.validationOptions.schemaValidation string Customize how deployment manager will validate the resource against schema errors.
base.options.validationOptions.undeclaredProperties string Specify what to do with extra properties when executing a request.
base.options.virtualProperties string Creates virtual properties described by JSON schema. These virtual properties will never be part of the API payload, but they can be consumed by input mappings. This must be a valid json schema draft-04.

This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by input mappings. For example:
"virtualProperties": "schema: http://json-schema.org/draft-04/schema#\ntype: object\nproperties:\n  [PROPERTY]:\n    type: [DATA_TYPE]\n  [ANOTHER_PROPERTY]:\n    type: [ANOTHER_DATA_TYPE]n"
description string An optional textual description of the resource; provided by the client when the resource is created.
id unsigned long [Output Only] Unique identifier for the resource; defined by the server.
insertTime string [Output Only] Timestamp when the type was created, in RFC3339 text format.
labels[] list Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
labels[].key string The key for a label.
labels[].value string The value of the label.
name string Name of the type.
operation nested object [Output Only] The Operation that most recently ran, or is currently running, on this type.

Methods

list
Lists all resource types for Deployment Manager.
Var denne siden nyttig? Si fra hva du synes:

Send tilbakemelding om ...

Cloud Deployment Manager Documentation