TypeProviders: listTypes

Requires authorization

Lists all the type info for a TypeProvider. Try it now.


HTTP request

GET https://www.googleapis.com/deploymentmanager/v2beta/projects/project/global/typeProviders/typeProvider/types


Parameter name Value Description
Path parameters
project string The project ID for this request.
typeProvider string The name of the type provider for this request.
Optional query parameters
filter string Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResults unsigned 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)
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.
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.


This request requires authorization with at least one of the following scopes (read more about authentication and authorization).


Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "types": [
      "kind": "deploymentmanager#typeInfo",
      "selfLink": string,
      "name": string,
      "title": string,
      "description": string,
      "documentationLink": string,
      "schema": {
        "input": string,
        "output": string
  "nextPageToken": string
Property name Value Description Notes
types[] list [Output Only] A list of resource type info.
types[].kind string [Output Only] Type of the output. Always deploymentManager#TypeInfo for TypeInfo.
types[].name string The base type or composite type name.
types[].title string The title on the API descriptor URL provided.
types[].description string The description of the type.
types[].schema nested object For base types with a collection, we return a schema and documentation link For template types, we return only a schema
types[].schema.input 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
types[].schema.output 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
nextPageToken string A token used to continue a truncated list request.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.