TypeProviders

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

Resource representations

A type provider that describes a service-backed Type.

{
  "id": unsigned long,
  "selfLink": string,
  "insertTime": string,
  "name": string,
  "description": string,
  "operation": operations Resource,
  "labels": [
    {
      "key": string,
      "value": string
    }
  ],
  "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
      }
    }
  ]
}

Property name	Value	Description	Notes
collectionOverrides[]	list	Allows resource handling overrides for specific collections
collectionOverrides[].collection	string	The collection that identifies this resource within its service.
collectionOverrides[].options	nested object	The options to apply to this resource-level override.
collectionOverrides[].options.inputMappings[]	list	The input mappings for requests.
collectionOverrides[].options.inputMappings[].fieldName	string	The name of the field that this input mapping applies to. For example, fingerprint.
collectionOverrides[].options.inputMappings[].location	string	The location where this mapping applies.
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)$'.
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.
collectionOverrides[].options.validationOptions	nested object	Sets the options for how to validate properties on a resource.
collectionOverrides[].options.validationOptions.schemaValidation	string	Customize how deployment manager will validate the resource against schema errors.
collectionOverrides[].options.validationOptions.undeclaredProperties	string	Specify what to do with extra properties when executing a request.
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"
credential	nested object	Credential used when interacting with this type.
credential.basicAuth	nested object	Basic Auth Credentials for this TypeProvider.
credential.basicAuth.password	string
credential.basicAuth.user	string
description	string	An optional textual description of the resource; provided by the client when the resource is created.
descriptorUrl	string	Descriptor Url for the this type provider.
id	unsigned long	[Output Only] Unique identifier for the resource; defined by the server.
insertTime	string	[Output Only] Timestamp when the type provider 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 this label.
labels[].value	string	The value for this label.
name	string	Name of the type provider.
operation	nested object	[Output Only] The Operation that most recently ran, or is currently running, on this type provider.
options	nested object	Options to apply when handling any resources in this service.
options.inputMappings[]	list	The input mappings for requests.
options.inputMappings[].fieldName	string	The name of the field that this input mapping applies to. For example, fingerprint.
options.inputMappings[].location	string	The location where this mapping applies.
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)$'.
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.
options.validationOptions	nested object	Sets the options for how to validate properties on a resource.
options.validationOptions.schemaValidation	string	Customize how deployment manager will validate the resource against schema errors.
options.validationOptions.undeclaredProperties	string	Specify what to do with extra properties when executing a request.
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"
selfLink	string	[Output Only] Self link for the type provider.

Methods

delete

Deletes a type provider.

get

Gets information about a specific type provider.

getType

Gets a type info for a type provided by a TypeProvider.

insert

Creates a type provider.

list

Lists all resource type providers for Deployment Manager.

listTypes

Lists all the type info for a TypeProvider.

patch

Updates a type provider. This method supports patch semantics.

update

Updates a type provider.