# Compute Engine API . regions

## Instance Methods

Returns the specified region resource.

Retrieves the list of region resources available to the specified project.

Retrieves the next page of results.

### Method Details

`get(project, region)`

    Returns the specified region resource.

    Args:
      project: string, Project ID for this request. (required)
      region: string, Name of the region resource to return. (required)

    Returns:
      An object of the form:

        { # Region resource.
        "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
        "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
        "description": "A String", # [Output Only] Textual description of the resource.
        "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this region.
          "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
          "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
          "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
          "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
          "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "quotas": [ # [Output Only] Quotas assigned to this region.
          { # A quotas entry.
            "usage": 3.14, # [Output Only] Current usage of this metric.
            "metric": "A String", # [Output Only] Name of the quota metric.
            "limit": 3.14, # [Output Only] Quota limit for this metric.
          },
        ],
        "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
          "A String",
        ],
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server .
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      }

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

    Retrieves the list of region resources available to the specified project.

    Args:
      project: string, Project ID for this request. (required)
      maxResults: integer, Maximum count of results to be returned.
      pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
      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 (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, filter=name ne example-instance.

    Returns:
      An object of the form:

        { # Contains a list of region resources.
        "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
        "items": [ # [Output Only] A list of Region resources.
          { # Region resource.
            "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
            "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
            "description": "A String", # [Output Only] Textual description of the resource.
            "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this region.
              "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
              "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
              "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
              "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
              "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
            },
            "quotas": [ # [Output Only] Quotas assigned to this region.
              { # A quotas entry.
                "usage": 3.14, # [Output Only] Current usage of this metric.
                "metric": "A String", # [Output Only] Name of the quota metric.
                "limit": 3.14, # [Output Only] Quota limit for this metric.
              },
            ],
            "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
              "A String",
            ],
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server .
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            "name": "A String", # [Output Only] Name of the resource.
          },
        ],
        "kind": "compute#regionList", # [Output Only] Type of resource. Always compute#regionList for lists of regions.
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for this 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.