docs/dyn/compute_v1.regions.html - platform/external/python/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.regions.html">regions</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#close">close()</a></code></p>
 <p class="firstline">Close httplib2 connections.</p>
 <p class="toc_element">
   <code><a href="#get">get(project, region, x__xgafv=None)</a></code></p>
 <p class="firstline">Returns the specified Region resource.</p>
 <p class="toc_element">
   <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Retrieves the list of region resources available to the specified project.</p>
 <p class="toc_element">
   <code><a href="#list_next">list_next()</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="close">close()</code>
   <pre>Close httplib2 connections.</pre>
 </div>

 <div class="method">
     <code class="details" id="get">get(project, region, x__xgafv=None)</code>
   <pre>Returns the specified Region resource.

 To decrease latency for this method, you can optionally omit any unneeded
 information from the response by using a field mask. This practice is
 especially recommended for unused quota information (the `quotas` field).
 To exclude one or more fields, set your request&#x27;s `fields` query parameter
 to only include the fields you need. For example, to only include the `id`
 and `selfLink` fields, add the query parameter `?fields=id,selfLink` to
 your request.

 This method fails if the quota information is unavailable for the region
 and if the organization policy constraint
 compute.requireBasicQuotaInResponse is enforced. This
 constraint, when enforced, disables the fail-open behaviour when quota
 information (the `items.quotas` field) is unavailable for the region.
 It is recommended to use the default setting
 for the constraint unless your application requires the fail-closed
 behaviour for this method.

 Args:
   project: string, Project ID for this request. (required)
   region: string, Name of the region resource to return. (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 Region resource.
     #
     # A region is a geographical area where a resource is located. For more
     # information, readRegions
     # and Zones.
   &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
       # text format.
   &quot;deprecated&quot;: { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this region.
     &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
         # resource is intended to change to DELETED. This is only
         # informational and the status will not change unless the client explicitly
         # changes it.
     &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
         # resource is intended to change to DEPRECATED. This is only
         # informational and the status will not change unless the client explicitly
         # changes it.
     &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
         # resource is intended to change to OBSOLETE. This is only
         # informational and the status will not change unless the client explicitly
         # changes it.
     &quot;replacement&quot;: &quot;A String&quot;, # 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.
     &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
         # Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
         # warning indicating the deprecated resource and recommending its
         # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
   },
   &quot;description&quot;: &quot;A String&quot;, # [Output Only] Textual description of the resource.
   &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
       # defined by the server.
   &quot;kind&quot;: &quot;compute#region&quot;, # [Output Only] Type of the resource. Always compute#region for
       # regions.
   &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
   &quot;quotaStatusWarning&quot;: { # [Output Only] Warning of fetching the `quotas` field for this region. This
       # field is populated only if fetching of the `quotas` field fails.
     &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
         # Engine returns NO_RESULTS_ON_PAGE if there
         # are no results in the response.
     &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
         # value format. For example:
         #
         # &quot;data&quot;: [
         #   {
         #    &quot;key&quot;: &quot;scope&quot;,
         #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
         #   }
       {
         &quot;key&quot;: &quot;A String&quot;, # [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).
         &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
       },
     ],
     &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
   },
   &quot;quotas&quot;: [ # [Output Only] Quotas assigned to this region.
     { # A quotas entry.
       &quot;limit&quot;: 3.14, # [Output Only] Quota limit for this metric.
       &quot;metric&quot;: &quot;A String&quot;, # [Output Only] Name of the quota metric.
       &quot;owner&quot;: &quot;A String&quot;, # [Output Only] Owning resource. This is the resource on which this quota
           # is applied.
       &quot;usage&quot;: 3.14, # [Output Only] Current usage of this metric.
     },
   ],
   &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
   &quot;status&quot;: &quot;A String&quot;, # [Output Only] Status of the region, either UP orDOWN.
   &quot;supportsPzs&quot;: True or False, # [Output Only] Reserved for future use.
   &quot;zones&quot;: [ # [Output Only] A list of zones available in this region, in the form of
       # resource URLs.
     &quot;A String&quot;,
   ],
 }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
   <pre>Retrieves the list of region resources available to the specified project.

 To decrease latency for this method, you can optionally omit any unneeded
 information from the response by using a field mask. This practice is
 especially recommended for unused quota information
 (the `items.quotas` field).
 To exclude one or more fields, set your request&#x27;s `fields` query parameter
 to only include the fields you need. For example, to only include the `id`
 and `selfLink` fields, add the query parameter `?fields=id,selfLink` to
 your request.

 This method fails if the quota information is unavailable for the region
 and if the organization policy constraint
 compute.requireBasicQuotaInResponse is enforced. This
 constraint, when enforced, disables the fail-open behaviour when quota
 information (the `items.quotas` field) is unavailable for the region.
 It is recommended to use the default setting
 for the constraint unless your application requires the fail-closed
 behaviour for this method.

 Args:
   project: string, Project ID for this request. (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 `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` 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 = &quot;Intel Skylake&quot;)
 ```
 By default, each expression is an `AND` expression. However, you
 can include `AND` and `OR` expressions explicitly.
 For example:
 ```
 (cpuPlatform = &quot;Intel Skylake&quot;) OR
 (cpuPlatform = &quot;Intel Broadwell&quot;) 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 &#x27;single quoted literal&#x27;`
 `fieldname eq &quot;double quoted literal&quot;`
 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`

 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 &quot;instance&quot;,
 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=&quot;creationTimestamp desc&quot;`. 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:

     { # Contains a list of region resources.
   &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
   &quot;items&quot;: [ # A list of Region resources.
     { # Represents a Region resource.
         #
         # A region is a geographical area where a resource is located. For more
         # information, readRegions
         # and Zones.
       &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
           # text format.
       &quot;deprecated&quot;: { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this region.
         &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
             # resource is intended to change to DELETED. This is only
             # informational and the status will not change unless the client explicitly
             # changes it.
         &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
             # resource is intended to change to DEPRECATED. This is only
             # informational and the status will not change unless the client explicitly
             # changes it.
         &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
             # resource is intended to change to OBSOLETE. This is only
             # informational and the status will not change unless the client explicitly
             # changes it.
         &quot;replacement&quot;: &quot;A String&quot;, # 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.
         &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
             # Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
             # warning indicating the deprecated resource and recommending its
             # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
       },
       &quot;description&quot;: &quot;A String&quot;, # [Output Only] Textual description of the resource.
       &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
           # defined by the server.
       &quot;kind&quot;: &quot;compute#region&quot;, # [Output Only] Type of the resource. Always compute#region for
           # regions.
       &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
       &quot;quotaStatusWarning&quot;: { # [Output Only] Warning of fetching the `quotas` field for this region. This
           # field is populated only if fetching of the `quotas` field fails.
         &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
             # Engine returns NO_RESULTS_ON_PAGE if there
             # are no results in the response.
         &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
             # value format. For example:
             #
             # &quot;data&quot;: [
             #   {
             #    &quot;key&quot;: &quot;scope&quot;,
             #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
             #   }
           {
             &quot;key&quot;: &quot;A String&quot;, # [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).
             &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
           },
         ],
         &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
       },
       &quot;quotas&quot;: [ # [Output Only] Quotas assigned to this region.
         { # A quotas entry.
           &quot;limit&quot;: 3.14, # [Output Only] Quota limit for this metric.
           &quot;metric&quot;: &quot;A String&quot;, # [Output Only] Name of the quota metric.
           &quot;owner&quot;: &quot;A String&quot;, # [Output Only] Owning resource. This is the resource on which this quota
               # is applied.
           &quot;usage&quot;: 3.14, # [Output Only] Current usage of this metric.
         },
       ],
       &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
       &quot;status&quot;: &quot;A String&quot;, # [Output Only] Status of the region, either UP orDOWN.
       &quot;supportsPzs&quot;: True or False, # [Output Only] Reserved for future use.
       &quot;zones&quot;: [ # [Output Only] A list of zones available in this region, in the form of
           # resource URLs.
         &quot;A String&quot;,
       ],
     },
   ],
   &quot;kind&quot;: &quot;compute#regionList&quot;, # [Output Only] Type of resource. Always compute#regionList for
       # lists of regions.
   &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] 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.
   &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
   &quot;warning&quot;: { # [Output Only] Informational warning message.
     &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
         # Engine returns NO_RESULTS_ON_PAGE if there
         # are no results in the response.
     &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
         # value format. For example:
         #
         # &quot;data&quot;: [
         #   {
         #    &quot;key&quot;: &quot;scope&quot;,
         #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
         #   }
       {
         &quot;key&quot;: &quot;A String&quot;, # [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).
         &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
       },
     ],
     &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
   },
 }</pre>
 </div>

 <div class="method">
     <code class="details" id="list_next">list_next()</code>
   <pre>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 &#x27;execute()&#x27; on to request the next
           page. Returns None if there are no more items in the collection.
         </pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.regions.html">regions</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#close">close()</a></code></p>
	<p class="firstline">Close httplib2 connections.</p>
	<p class="toc_element">
	<code><a href="#get">get(project, region, x__xgafv=None)</a></code></p>
	<p class="firstline">Returns the specified Region resource.</p>
	<p class="toc_element">
	<code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Retrieves the list of region resources available to the specified project.</p>
	<p class="toc_element">
	<code><a href="#list_next">list_next()</a></code></p>
	<p class="firstline">Retrieves the next page of results.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="close">close()</code>
	<pre>Close httplib2 connections.</pre>
	</div>

	<div class="method">
	<code class="details" id="get">get(project, region, x__xgafv=None)</code>
	<pre>Returns the specified Region resource.

	To decrease latency for this method, you can optionally omit any unneeded
	information from the response by using a field mask. This practice is
	especially recommended for unused quota information (the `quotas` field).
	To exclude one or more fields, set your request's `fields` query parameter
	to only include the fields you need. For example, to only include the `id`
	and `selfLink` fields, add the query parameter `?fields=id,selfLink` to
	your request.

	This method fails if the quota information is unavailable for the region
	and if the organization policy constraint
	compute.requireBasicQuotaInResponse is enforced. This
	constraint, when enforced, disables the fail-open behaviour when quota
	information (the `items.quotas` field) is unavailable for the region.
	It is recommended to use the default setting
	for the constraint unless your application requires the fail-closed
	behaviour for this method.

	Args:
	project: string, Project ID for this request. (required)
	region: string, Name of the region resource to return. (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 Region resource.
	#
	# A region is a geographical area where a resource is located. For more
	# information, readRegions
	# and Zones.
	"creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
	# text format.
	"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 state of this
	# resource is intended to change to DELETED. This is only
	# informational and the status will not change unless the client explicitly
	# changes it.
	"deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this
	# resource is intended to change to DEPRECATED. This is only
	# informational and the status will not change unless the client explicitly
	# changes it.
	"obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this
	# resource is intended to change to OBSOLETE. This is only
	# informational and the status will not change unless the client explicitly
	# changes it.
	"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.
	"state": "A String", # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
	# Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
	# warning indicating the deprecated resource and recommending its
	# replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
	},
	"description": "A String", # [Output Only] Textual description of the resource.
	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
	# defined by the server.
	"kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for
	# regions.
	"name": "A String", # [Output Only] Name of the resource.
	"quotaStatusWarning": { # [Output Only] Warning of fetching the `quotas` field for this region. This
	# field is populated only if fetching of the `quotas` field fails.
	"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.
	},
	"quotas": [ # [Output Only] Quotas assigned to this region.
	{ # A quotas entry.
	"limit": 3.14, # [Output Only] Quota limit for this metric.
	"metric": "A String", # [Output Only] Name of the quota metric.
	"owner": "A String", # [Output Only] Owning resource. This is the resource on which this quota
	# is applied.
	"usage": 3.14, # [Output Only] Current usage of this metric.
	},
	],
	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
	"status": "A String", # [Output Only] Status of the region, either UP orDOWN.
	"supportsPzs": True or False, # [Output Only] Reserved for future use.
	"zones": [ # [Output Only] A list of zones available in this region, in the form of
	# resource URLs.
	"A String",
	],
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
	<pre>Retrieves the list of region resources available to the specified project.

	To decrease latency for this method, you can optionally omit any unneeded
	information from the response by using a field mask. This practice is
	especially recommended for unused quota information
	(the `items.quotas` field).
	To exclude one or more fields, set your request's `fields` query parameter
	to only include the fields you need. For example, to only include the `id`
	and `selfLink` fields, add the query parameter `?fields=id,selfLink` to
	your request.

	This method fails if the quota information is unavailable for the region
	and if the organization policy constraint
	compute.requireBasicQuotaInResponse is enforced. This
	constraint, when enforced, disables the fail-open behaviour when quota
	information (the `items.quotas` field) is unavailable for the region.
	It is recommended to use the default setting
	for the constraint unless your application requires the fail-closed
	behaviour for this method.

	Args:
	project: string, Project ID for this request. (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:

	{ # Contains a list of region resources.
	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
	"items": [ # A list of Region resources.
	{ # Represents a Region resource.
	#
	# A region is a geographical area where a resource is located. For more
	# information, readRegions
	# and Zones.
	"creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
	# text format.
	"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 state of this
	# resource is intended to change to DELETED. This is only
	# informational and the status will not change unless the client explicitly
	# changes it.
	"deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this
	# resource is intended to change to DEPRECATED. This is only
	# informational and the status will not change unless the client explicitly
	# changes it.
	"obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this
	# resource is intended to change to OBSOLETE. This is only
	# informational and the status will not change unless the client explicitly
	# changes it.
	"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.
	"state": "A String", # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
	# Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
	# warning indicating the deprecated resource and recommending its
	# replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
	},
	"description": "A String", # [Output Only] Textual description of the resource.
	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
	# defined by the server.
	"kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for
	# regions.
	"name": "A String", # [Output Only] Name of the resource.
	"quotaStatusWarning": { # [Output Only] Warning of fetching the `quotas` field for this region. This
	# field is populated only if fetching of the `quotas` field fails.
	"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.
	},
	"quotas": [ # [Output Only] Quotas assigned to this region.
	{ # A quotas entry.
	"limit": 3.14, # [Output Only] Quota limit for this metric.
	"metric": "A String", # [Output Only] Name of the quota metric.
	"owner": "A String", # [Output Only] Owning resource. This is the resource on which this quota
	# is applied.
	"usage": 3.14, # [Output Only] Current usage of this metric.
	},
	],
	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
	"status": "A String", # [Output Only] Status of the region, either UP orDOWN.
	"supportsPzs": True or False, # [Output Only] Reserved for future use.
	"zones": [ # [Output Only] A list of zones available in this region, in the form of
	# resource URLs.
	"A String",
	],
	},
	],
	"kind": "compute#regionList", # [Output Only] Type of resource. Always compute#regionList for
	# lists of regions.
	"nextPageToken": "A String", # [Output Only] 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", # [Output Only] Server-defined URL for this resource.
	"warning": { # [Output Only] 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.
	},
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list_next">list_next()</code>
	<pre>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.
	</pre>
	</div>

	</body></html>