# Compute Engine API . hosts

## Instance Methods

Close httplib2 connections.

Retrieves information about the specified host.

Allows customers to get SBOM versions of a host.

Retrieves a list of hosts.

Retrieves the next page of results.

### Method Details

`close()`

    Close httplib2 connections.

`get(project, zone, association, host, x__xgafv=None)`

    Retrieves information about the specified host.

    Args:
      project: string, The project ID for this request. (required)
      zone: string, The name of the zone for this request, formatted as RFC1035. (required)
      association: string, The parent resource association for the Host. This field specifies the
    hierarchical context (e.g., reservation, block, sub-block) when
    accessing the host. For example, reservations/reservation_name,
    reservations/reservation_name/reservationBlocks/reservation_block_name or
    reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name. (required)
      host: string, The name of the host, formatted as RFC1035 or a resource ID
    number. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Represents a host resource.
      "aliasLinks": [ # Output only. All aliases for this resource.
          # e.g.
          # projects/123/zones/us-centra1-a/reservation/r1/reservationBlock/b1/hosts/h1
        "A String",
      ],
      "creationTimestamp": "A String", # Output only. The creation timestamp, formatted asRFC3339 text.
      "description": "A String", # An optional description of this resource.
      "id": "A String", # Output only. The unique identifier for this resource. This identifier is
          # defined by the server.
      "kind": "compute#host", # Output only. The type of resource. Alwayscompute#host for hosts.
      "name": "A String", # Output only. The name of the host.
      "selfLink": "A String", # Output only. The self link of the host.
      "selfLinkWithId": "A String", # Output only. The self link with id of the host.
      "state": "A String", # Output only. The state of the host.
      "status": { # Output only. The status of the host
        "physicalTopology": { # Output only. The physical topology of the reservation sub-block, if
            # present
          "block": "A String", # The unique identifier of the capacity block within the cluster.
          "cluster": "A String", # The cluster name of the reservation sub-block.
          "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
          "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
              # block.
        },
        "runningInstances": [ # Output only. The URIs of the instances currently running on this host.
          "A String",
        ],
      },
      "zone": "A String", # Output only. The zone in which the host resides.
    }

`getVersion(project, zone, association, host, body=None, requestId=None, x__xgafv=None)`

    Allows customers to get SBOM versions of a host.

    Args:
      project: string, Project ID for this request. (required)
      zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
      association: string, The parent resource association for the Host. This field specifies the
    hierarchical context (e.g., reservation, block, sub-block) when
    accessing the host. (required)
      host: string, The name of the host, formatted as RFC1035 or a resource ID
    number. (required)
      body: object, The request body.
        The object takes the form of:

    {
      "sbomSelections": [ # The SBOM selection to return. Duplicate values in the list will be ignored.
        "A String",
      ],
    }

      requestId: string, An optional request ID to identify requests. Specify a unique request ID so
    that if you must retry your request, the server will know to ignore the
    request if it has already been completed.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Represents an Operation resource.
        #
        # Google Compute Engine has three Operation resources:
        #
        # * [Global](/compute/docs/reference/rest/v1/globalOperations)
        # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
        # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
        #
        # You can use an operation resource to manage asynchronous API requests.
        # For more information, readHandling
        # 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 `zoneOperations` resource.
        #
        #
        #
        # For more information, read
        # Global, Regional, and Zonal Resources.
        #
        # Note that completed Operation resources have a limited
        # retention period.
      "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 inRFC3339
          # 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.
          { # 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.
          },
        ],
      },
      "getVersionOperationMetadata": {
        "inlineSbomInfo": {
          "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
              # appropriate identifiers.
            "a_key": "A String",
          },
          "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
              # identifiers.
            "a_key": "A String",
          },
        },
      },
      "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 inRFC3339
          # text format.
      "instancesBulkInsertOperationMetadata": {
        "perLocationStatus": { # Status information per location (location name is key).
            # Example key: zones/us-central1-a
          "a_key": {
            "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
            "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
            "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
                # error.
            "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
                # if the flow is rolling forward or rolling back.
            "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
          },
        },
      },
      "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
          # Operation resources.
      "name": "A String", # [Output Only] Name of the operation.
      "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
          # group of operations results from a `bulkInsert` API request.
      "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.
      "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
          # this field will contain information on all underlying zonal actions and
          # their state.
        "clientOperationId": "A String", # [Output Only] The client operation id.
        "perLocationOperations": { # [Output Only] Status information per location (location name is key).
            # Example key: zones/us-central1-a
          "a_key": {
            "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
                # populated.
                # different programming environments, including REST APIs and RPC APIs. It is
                # used by [gRPC](https://github.com/grpc). Each `Status` message contains
                # three pieces of data: error code, error message, and error details.
                #
                # You can find out more about this error model and how to work with it in the
                # [API Design Guide](https://cloud.google.com/apis/design/errors).
              "code": 42, # The status code, which should be an enum value of google.rpc.Code.
              "details": [ # A list of messages that carry the error details.  There is a common set of
                  # message types for APIs to use.
                {
                  "a_key": "", # Properties of the object. Contains field @type with type URL.
                },
              ],
              "message": "A String", # A developer-facing error message, which should be in English. Any
                  # user-facing error message should be localized and sent in the
                  # google.rpc.Status.details field, or localized by the client.
            },
            "state": "A String", # [Output Only] Status of the action, which can be one of the following:
                # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
          },
        },
      },
      "startTime": "A String", # [Output Only] The time that this operation was started by the server.
          # This value is inRFC3339
          # 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 disk
          # that the snapshot was created from.
      "user": "A String", # [Output Only] User who requested the operation, for example:
          # `user@example.com` or
          # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
      "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.
    }

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

    Retrieves a list of hosts.

    Args:
      project: string, The project ID for this request. (required)
      zone: string, The name of the zone for this request, formatted as RFC1035. (required)
      association: string, The parent resource association for the Host. This field specifies the
    hierarchical context (e.g., reservation, block, sub-block) when
    accessing the host. For example, reservations/reservation_name,
    reservations/reservation_name/reservationBlocks/reservation_block_name or
    reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_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:

        {
      "etag": "A String",
      "id": "A String", # The unique identifier for the resource; defined by the server.
      "items": [ # A list of host resources.
        { # Represents a host resource.
          "aliasLinks": [ # Output only. All aliases for this resource.
              # e.g.
              # projects/123/zones/us-centra1-a/reservation/r1/reservationBlock/b1/hosts/h1
            "A String",
          ],
          "creationTimestamp": "A String", # Output only. The creation timestamp, formatted asRFC3339 text.
          "description": "A String", # An optional description of this resource.
          "id": "A String", # Output only. The unique identifier for this resource. This identifier is
              # defined by the server.
          "kind": "compute#host", # Output only. The type of resource. Alwayscompute#host for hosts.
          "name": "A String", # Output only. The name of the host.
          "selfLink": "A String", # Output only. The self link of the host.
          "selfLinkWithId": "A String", # Output only. The self link with id of the host.
          "state": "A String", # Output only. The state of the host.
          "status": { # Output only. The status of the host
            "physicalTopology": { # Output only. The physical topology of the reservation sub-block, if
                # present
              "block": "A String", # The unique identifier of the capacity block within the cluster.
              "cluster": "A String", # The cluster name of the reservation sub-block.
              "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
              "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
                  # block.
            },
            "runningInstances": [ # Output only. The URIs of the instances currently running on this host.
              "A String",
            ],
          },
          "zone": "A String", # Output only. The zone in which the host resides.
        },
      ],
      "kind": "compute#hostList", # The type of resource. Always compute#host for a list of hosts.
      "nextPageToken": "A String", # This token allows you to get the next page of results for
          # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
          # the query parameter pageToken in the next list request.
          # Subsequent list requests will have their own nextPageToken to
          # continue paging through the results.
      "selfLink": "A String", # The server-defined URL for this resource.
      "unreachables": [ # Unreachable resources.
          # end_interface: MixerListResponseWithEtagBuilder
        "A String",
      ],
      "warning": { # An informational warning message.
        "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()`

    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.