# Deployment Manager API . deployments

## Instance Methods

Retrieves the next page of results.

### Method Details

`delete(projectId, region, deploymentName)`

    Args:
      projectId: string, A parameter (required)
      region: string, A parameter (required)
      deploymentName: string, A parameter (required)

`get(projectId, region, deploymentName)`

    Args:
      projectId: string, A parameter (required)
      region: string, A parameter (required)
      deploymentName: string, A parameter (required)

    Returns:
      An object of the form:

        { # A deployment represents a physical instantiation of a Template.
          "description": "A String", # A user-supplied description of this Deployment.
          "templateName": "A String", # The name of the Template on which this deployment is based.
          "overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
            { # A specification for overriding parameters in a Template that corresponds to the Deployment.
              "path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
              "value": "A String", # The new value to assign to the overridden parameter.
            },
          ],
          "modules": { # [Output Only] List of status for the modules in this deployment.
            "a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
              "healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
                "healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
              },
              "replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
                "resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
                "replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
              },
              "networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
                "networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
              },
              "state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
                "status": "A String", # [Output Only] The status of the deployment. Possible values include:
                    # - UNKNOWN
                    # - DEPLOYING
                    # - DEPLOYED
                    # - DEPLOYMENT_FAILED
                    # - DELETING
                    # - DELETED
                    # - DELETE_FAILED
                "details": "A String", # [Output Only] Human readable details about the current state.
              },
              "autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
                "autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
              },
              "firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
                "firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
              },
              "type": "A String", # [Output Only] The type of the module.
              "lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
                "forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
                "targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
              },
            },
          },
          "state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
            "status": "A String", # [Output Only] The status of the deployment. Possible values include:
                # - UNKNOWN
                # - DEPLOYING
                # - DEPLOYED
                # - DEPLOYMENT_FAILED
                # - DELETING
                # - DELETED
                # - DELETE_FAILED
            "details": "A String", # [Output Only] Human readable details about the current state.
          },
          "creationDate": "A String", # [Output Only] The time when this deployment was created.
          "name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
        }

`insert(projectId, region, body)`

    Args:
      projectId: string, A parameter (required)
      region: string, A parameter (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # A deployment represents a physical instantiation of a Template.
        "description": "A String", # A user-supplied description of this Deployment.
        "templateName": "A String", # The name of the Template on which this deployment is based.
        "overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
          { # A specification for overriding parameters in a Template that corresponds to the Deployment.
            "path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
            "value": "A String", # The new value to assign to the overridden parameter.
          },
        ],
        "modules": { # [Output Only] List of status for the modules in this deployment.
          "a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
            "healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
              "healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
            },
            "replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
              "resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
              "replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
            },
            "networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
              "networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
            },
            "state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
              "status": "A String", # [Output Only] The status of the deployment. Possible values include:
                  # - UNKNOWN
                  # - DEPLOYING
                  # - DEPLOYED
                  # - DEPLOYMENT_FAILED
                  # - DELETING
                  # - DELETED
                  # - DELETE_FAILED
              "details": "A String", # [Output Only] Human readable details about the current state.
            },
            "autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
              "autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
            },
            "firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
              "firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
            },
            "type": "A String", # [Output Only] The type of the module.
            "lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
              "forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
              "targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
            },
          },
        },
        "state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
          "status": "A String", # [Output Only] The status of the deployment. Possible values include:
              # - UNKNOWN
              # - DEPLOYING
              # - DEPLOYED
              # - DEPLOYMENT_FAILED
              # - DELETING
              # - DELETED
              # - DELETE_FAILED
          "details": "A String", # [Output Only] Human readable details about the current state.
        },
        "creationDate": "A String", # [Output Only] The time when this deployment was created.
        "name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
      }

    Returns:
      An object of the form:

        { # A deployment represents a physical instantiation of a Template.
          "description": "A String", # A user-supplied description of this Deployment.
          "templateName": "A String", # The name of the Template on which this deployment is based.
          "overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
            { # A specification for overriding parameters in a Template that corresponds to the Deployment.
              "path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
              "value": "A String", # The new value to assign to the overridden parameter.
            },
          ],
          "modules": { # [Output Only] List of status for the modules in this deployment.
            "a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
              "healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
                "healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
              },
              "replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
                "resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
                "replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
              },
              "networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
                "networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
              },
              "state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
                "status": "A String", # [Output Only] The status of the deployment. Possible values include:
                    # - UNKNOWN
                    # - DEPLOYING
                    # - DEPLOYED
                    # - DEPLOYMENT_FAILED
                    # - DELETING
                    # - DELETED
                    # - DELETE_FAILED
                "details": "A String", # [Output Only] Human readable details about the current state.
              },
              "autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
                "autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
              },
              "firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
                "firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
              },
              "type": "A String", # [Output Only] The type of the module.
              "lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
                "forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
                "targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
              },
            },
          },
          "state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
            "status": "A String", # [Output Only] The status of the deployment. Possible values include:
                # - UNKNOWN
                # - DEPLOYING
                # - DEPLOYED
                # - DEPLOYMENT_FAILED
                # - DELETING
                # - DELETED
                # - DELETE_FAILED
            "details": "A String", # [Output Only] Human readable details about the current state.
          },
          "creationDate": "A String", # [Output Only] The time when this deployment was created.
          "name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
        }

`list(projectId, region, pageToken=None, maxResults=None)`

    Args:
      projectId: string, A parameter (required)
      region: string, A parameter (required)
      pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
      maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)

    Returns:
      An object of the form:

        {
        "nextPageToken": "A String",
        "resources": [
          { # A deployment represents a physical instantiation of a Template.
              "description": "A String", # A user-supplied description of this Deployment.
              "templateName": "A String", # The name of the Template on which this deployment is based.
              "overrides": [ # The set of parameter overrides to apply to the corresponding Template before deploying.
                { # A specification for overriding parameters in a Template that corresponds to the Deployment.
                  "path": "A String", # A JSON Path expression that specifies which parameter should be overridden.
                  "value": "A String", # The new value to assign to the overridden parameter.
                },
              ],
              "modules": { # [Output Only] List of status for the modules in this deployment.
                "a_key": { # [Output Only] Aggregate status for a module. # Name of the module.
                  "healthCheckModuleStatus": { # [Output Only] The status of the HealthCheckModule, set for type HEALTH_CHECK.
                    "healthCheckUrl": "A String", # [Output Only] The HealthCheck URL.
                  },
                  "replicaPoolModuleStatus": { # [Output Only] The status of the ReplicaPoolModule, set for type VM.
                    "resourceViewUrl": "A String", # [Output Only] The URL of the Resource Group associated with this ReplicaPool.
                    "replicaPoolUrl": "A String", # [Output Only] The URL of the associated ReplicaPool resource.
                  },
                  "networkModuleStatus": { # [Output Only] The status of the NetworkModule, set for type NETWORK.
                    "networkUrl": "A String", # [Output Only] The URL of the corresponding Network resource.
                  },
                  "state": { # [Output Only] The current state of a replica or module. # [Output Only] The current state of the module.
                    "status": "A String", # [Output Only] The status of the deployment. Possible values include:
                        # - UNKNOWN
                        # - DEPLOYING
                        # - DEPLOYED
                        # - DEPLOYMENT_FAILED
                        # - DELETING
                        # - DELETED
                        # - DELETE_FAILED
                    "details": "A String", # [Output Only] Human readable details about the current state.
                  },
                  "autoscalingModuleStatus": { # [Output Only] The status of the AutoscalingModule, set for type AUTOSCALING.
                    "autoscalingConfigUrl": "A String", # [Output Only] The URL of the corresponding Autoscaling configuration.
                  },
                  "firewallModuleStatus": { # [Output Only] The status of the FirewallModule, set for type FIREWALL.
                    "firewallUrl": "A String", # [Output Only] The URL of the corresponding Firewall resource.
                  },
                  "type": "A String", # [Output Only] The type of the module.
                  "lbModuleStatus": { # [Output Only] The status of the LbModule, set for type LOAD_BALANCING.
                    "forwardingRuleUrl": "A String", # [Output Only] The URL of the corresponding ForwardingRule in GCE.
                    "targetPoolUrl": "A String", # [Output Only] The URL of the corresponding TargetPool resource in GCE.
                  },
                },
              },
              "state": { # [Output Only] The current state of a replica or module. # [Output Only] Current status of this deployment.
                "status": "A String", # [Output Only] The status of the deployment. Possible values include:
                    # - UNKNOWN
                    # - DEPLOYING
                    # - DEPLOYED
                    # - DEPLOYMENT_FAILED
                    # - DELETING
                    # - DELETED
                    # - DELETE_FAILED
                "details": "A String", # [Output Only] Human readable details about the current state.
              },
              "creationDate": "A String", # [Output Only] The time when this deployment was created.
              "name": "A String", # Name of this deployment. The name must conform to the following regular expression: [a-zA-Z0-9-_]{1,64}
            },
        ],
      }

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