# Google Cloud Deployment Manager API V2Beta Methods . types

## Instance Methods

Lists all resource types for Deployment Manager.

Retrieves the next page of results.

### Method Details

`list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)`

    Lists all resource types for Deployment Manager.

    Args:
      project: string, The project ID for this request. (required)
      filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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`.

    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) ```
      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`)
      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.

    Returns:
      An object of the form:

        { # A response that returns all Types supported by Deployment Manager
        "nextPageToken": "A String", # A token used to continue a truncated list request.
        "types": [ # Output only. A list of resource types supported by Deployment Manager.
          { # A resource type supported by Deployment Manager.
            "base": { # BaseType that describes a service-backed Type. # Base Type (configurable service) that backs this Type.
              "collectionOverrides": [ # Allows resource handling overrides for specific collections
                { # CollectionOverride allows resource handling overrides for specific resources within a BaseType
                  "collection": "A String", # The collection that identifies this resource within its service.
                  "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override
                    "asyncOptions": [ # Options regarding how to thread async requests.
                      { # Async options that determine when a resource should finish.
                        "methodMatch": "A String", # Method regex where this policy will apply.
                        "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.
                          "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user.
                            {
                              "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic.
                              "level": "A String", # Level to record this diagnostic.
                            },
                          ],
                          "failCondition": "A String", # JsonPath expression that determines if the request failed.
                          "finishCondition": "A String", # JsonPath expression that determines if the request is completed.
                          "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll.
                          "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource.
                        },
                      },
                    ],
                    "inputMappings": [ # The mappings that apply for requests.
                      { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
                        "fieldName": "A String", # The name of the field that is going to be injected.
                        "location": "A String", # The location where this mapping applies.
                        "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
                        "value": "A String", # A jsonPath expression to select an element.
                      },
                    ],
                    "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
                      "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
                      "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
                    },
                    "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
                  },
                },
              ],
              "credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Credential used when interacting with this type.
                "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.
                  "password": "A String",
                  "user": "A String",
                },
                "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.
                  "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com
                },
                "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
              },
              "descriptorUrl": "A String", # Descriptor Url for the this type.
              "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service.
                "asyncOptions": [ # Options regarding how to thread async requests.
                  { # Async options that determine when a resource should finish.
                    "methodMatch": "A String", # Method regex where this policy will apply.
                    "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.
                      "diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user.
                        {
                          "field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic.
                          "level": "A String", # Level to record this diagnostic.
                        },
                      ],
                      "failCondition": "A String", # JsonPath expression that determines if the request failed.
                      "finishCondition": "A String", # JsonPath expression that determines if the request is completed.
                      "pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll.
                      "targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource.
                    },
                  },
                ],
                "inputMappings": [ # The mappings that apply for requests.
                  { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
                    "fieldName": "A String", # The name of the field that is going to be injected.
                    "location": "A String", # The location where this mapping applies.
                    "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
                    "value": "A String", # A jsonPath expression to select an element.
                  },
                ],
                "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
                  "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
                  "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
                },
                "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
              },
            },
            "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
            "id": "A String",
            "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
            "labels": [ # 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])?)?`.
              {
                "key": "A String",
                "value": "A String",
              },
            ],
            "name": "A String", # Name of the type.
            "operation": { # Represents an Operation resource. # Output only. The Operation that most recently ran, or is currently running, on this type.
                #
                # 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. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
              "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
              "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
              "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
              "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
              "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
                "errors": [ # [Output Only] The array of errors encountered while processing this operation.
                  {
                    "code": "A String", # [Output Only] The error type identifier for this error.
                    "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
                    "message": "A String", # [Output Only] An optional, human-readable error message.
                  },
                ],
              },
              "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
              "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.
              "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
              "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
              "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
              "name": "A String", # [Output Only] Name of the operation.
              "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
              "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.
              "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
              "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
              "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
              "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
              "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
              "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
              "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.
              "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
              "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
                {
                  "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.
                  "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                      # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                    {
                      "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).
                      "value": "A String", # [Output Only] A warning data value corresponding to the key.
                    },
                  ],
                  "message": "A String", # [Output Only] A human-readable description of the warning code.
                },
              ],
              "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
            },
            "selfLink": "A String", # Output only. Server defined URL for the resource.
          },
        ],
      }

`list_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.