# Compute Engine API . reservationConsumedInstances

## Instance Methods

Close httplib2 connections.

Lists the instances consuming capacity from a specific reservation.

Retrieves the next page of results.

### Method Details

`close()`

    Close httplib2 connections.

`list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)`

    Lists the instances consuming capacity from a specific reservation.

    Args:
      project: string, Required. Project ID for this request. (required)
      zone: string, Required. Zone name for this request. (required)
      reservation: string, Required. The name of the reservation to list consumed instances for. In the format
    of reservations/{reservation_name} (required)
      filter: string, A filter expression that filters resources listed in the response. Most
    Compute resources support two types of filter expressions:
    expressions that support regular expressions and expressions that follow
    API improvement proposal AIP-160.
    These two types of filter expressions cannot be mixed in one request.

    If you want to use AIP-160, your expression must specify the field name, an
    operator, and the value that you want to use for filtering. The value
    must be a string, a number, or a boolean. The 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`.

    The `:*` comparison can be used to test whether a key has been defined.
    For example, to find all objects with `owner` label use:
    ```
    labels.owner:*
    ```

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

    If you want to use a regular expression, use the `eq` (equal) or `ne`
    (not equal) operator against a single un-parenthesized expression with or
    without quotes or against multiple parenthesized expressions. Examples:

    `fieldname eq unquoted literal`
    `fieldname eq 'single quoted literal'`
    `fieldname eq "double quoted literal"`
    `(fieldname1 eq literal) (fieldname2 ne "literal")`

    The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
    The literal value must match the entire field.

    For example, to filter for instances that do not end with name "instance",
    you would use `name ne .*instance`.

    You cannot combine constraints on multiple fields using regular
    expressions.
      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.
      returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
    of failure. The default value is false.

    For example, when partial success behavior is enabled, aggregatedList for a
    single zone scope either returns all resources in the zone or no resources,
    with an error code.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for listing reservation consumed instances.
      "id": "A String", # Uniquely identifies the type of this resource.
      "items": [ # A list of ReservationConsumedInstance resources.
        { # ReservationConsumedInstance represents a consumed instance.
          "instance": "A String", # The full URI of the instance resource.
          "service": "A String", # The service to which the instance belongs. Typically "COMPUTE".
          "status": { # Status information for the instance's consumption of the reservation. # Output only. [Output Only] The status of the consumed instance.
            "linkageErrors": { # A list of issues related to this instance's linkage to the reservation.
              "errors": [ # [Output Only] The array of errors encountered while processing this
                  # operation.
                { # Represents a single error encountered during the processing of an
                    # operation.
                  "code": "A String", # [Output Only] The error type identifier for this error.
                  "errorDetails": [ # [Output Only] An optional list of messages that contain the error
                      # details. There is a set of defined message types to use for providing
                      # details.The syntax depends on the error code. For example,
                      # QuotaExceededInfo will have details when the error code is
                      # QUOTA_EXCEEDED.
                    { # Container for structured error details providing additional context
                        # specific to the encountered error code.
                      "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata.
                          #
                          # Example of an error when contacting the "pubsub.googleapis.com" API when it
                          # is not enabled:
                          #
                          #     { "reason": "API_DISABLED"
                          #       "domain": "googleapis.com"
                          #       "metadata": {
                          #         "resource": "projects/123",
                          #         "service": "pubsub.googleapis.com"
                          #       }
                          #     }
                          #
                          # This response indicates that the pubsub.googleapis.com API is not enabled.
                          #
                          # Example of an error that is returned when attempting to create a Spanner
                          # instance in a region that is out of stock:
                          #
                          #     { "reason": "STOCKOUT"
                          #       "domain": "spanner.googleapis.com",
                          #       "metadata": {
                          #         "availableRegions": "us-central1,us-east2"
                          #       }
                          #     }
                        "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
                            # is typically the registered service name of the tool or product that
                            # generates the error. Example: "pubsub.googleapis.com". If the error is
                            # generated by some common infrastructure, the error domain must be a
                            # globally unique value that identifies the infrastructure. For Google API
                            # infrastructure, the error domain is "googleapis.com".
                        "metadatas": { # Additional structured details about this error.
                            #
                            # Keys must match a regular expression of `a-z+` but should
                            # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
                            # length. When identifying the current value of an exceeded limit, the units
                            # should be contained in the key, not the value.  For example, rather than
                            # `{"instanceLimit": "100/request"}`, should be returned as,
                            # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
                            # instances that can be created in a single (batch) request.
                          "a_key": "A String",
                        },
                        "reason": "A String", # The reason of the error. This is a constant value that identifies the
                            # proximate cause of the error. Error reasons are unique within a particular
                            # domain of errors. This should be at most 63 characters and match a
                            # regular expression of `A-Z+[A-Z0-9]`, which represents
                            # UPPER_SNAKE_CASE.
                      },
                      "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error.
                          #
                          # For example, if a quota check failed with an error indicating the calling
                          # project hasn't enabled the accessed service, this can contain a URL pointing
                          # directly to the right place in the developer console to flip the bit.
                        "links": [ # URL(s) pointing to additional information on handling the current error.
                          { # Describes a URL link.
                            "description": "A String", # Describes what the link offers.
                            "url": "A String", # The URL of the link.
                          },
                        ],
                      },
                      "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users.
                          # which can be attached to an RPC error.
                        "locale": "A String", # The locale used following the specification defined at
                            # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
                            # Examples are: "en-US", "fr-CH", "es-MX"
                        "message": "A String", # The localized error message in the above locale.
                      },
                      "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded.
                        "dimensions": { # The map holding related quota dimensions.
                          "a_key": "A String",
                        },
                        "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
                            #  type or metric.
                        "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
                            # or metric.
                        "limitName": "A String", # The name of the quota limit.
                        "metricName": "A String", # The Compute Engine quota metric name.
                        "rolloutStatus": "A String", # Rollout status of the future quota limit.
                      },
                    },
                  ],
                  "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.
                },
              ],
            },
          },
        },
      ],
      "kind": "A String", # Identifies the resource as a list of reservation consumed instances.
      "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
          # list requests.
      "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
      "warning": { # [Output Only] Informational warning which replaces the result in some
          # cases.
        "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.
      },
    }

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