Compute Engine API . regions

Instance Methods

get(project, region)

Returns the specified region resource.

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

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

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(project, region)
Returns the specified region resource.

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

Returns:
  An object of the form:

    { # Region resource.
    "status": "A String", # Status of the region, "UP" or "DOWN".
    "kind": "compute#region", # Type of the resource.
    "description": "A String", # Textual description of the resource.
    "deprecated": { # Deprecation status for a public resource. # 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. 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. New uses of "OBSOLETE" or "DELETED" resources will 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", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
    },
    "quotas": [ # Quotas assigned to this region.
      { # A quotas entry.
        "usage": 3.14, # Current usage of this metric.
        "metric": "A String", # Name of the quota metric.
        "limit": 3.14, # Quota limit for this metric.
      },
    ],
    "zones": [ # A list of zones homed in this region, in the form of resource URLs.
      "A String",
    ],
    "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
    "id": "A String", # Unique identifier for the resource; defined by the server (output only).
    "selfLink": "A String", # Server defined URL for the resource (output only).
    "name": "A String", # 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, Name of the project scoping this request. (required)
  maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
  pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
  filter: string, Optional. Filter expression for filtering listed resources.

Returns:
  An object of the form:

    { # Contains a list of region resources.
    "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
    "items": [ # The region resources.
      { # Region resource.
        "status": "A String", # Status of the region, "UP" or "DOWN".
        "kind": "compute#region", # Type of the resource.
        "description": "A String", # Textual description of the resource.
        "deprecated": { # Deprecation status for a public resource. # 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. 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. New uses of "OBSOLETE" or "DELETED" resources will 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", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
        },
        "quotas": [ # Quotas assigned to this region.
          { # A quotas entry.
            "usage": 3.14, # Current usage of this metric.
            "metric": "A String", # Name of the quota metric.
            "limit": 3.14, # Quota limit for this metric.
          },
        ],
        "zones": [ # A list of zones homed in this region, in the form of resource URLs.
          "A String",
        ],
        "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
        "id": "A String", # Unique identifier for the resource; defined by the server (output only).
        "selfLink": "A String", # Server defined URL for the resource (output only).
        "name": "A String", # Name of the resource.
      },
    ],
    "kind": "compute#regionList", # Type of resource.
    "id": "A String", # Unique identifier for the resource; defined by the server (output only).
    "selfLink": "A String", # Server defined URL for this resource (output only).
  }
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.