| <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_preview.html">Compute Engine API</a> . <a href="compute_preview.regionZones.html">regionZones</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="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Retrieves the list of Zone resources under the specific region available to</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next(previous_request, previous_response)</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="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Retrieves the list of Zone resources under the specific region available to | |
| the specified project. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Region 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. | |
| 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 zone resources. | |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. | |
| "items": [ # A list of Zone resources. | |
| { # Represents a Zone resource. | |
| # | |
| # A zone is a deployment area. These deployment areas are subsets of a region. | |
| # For example the zone us-east1-b is located in theus-east1 region. For more information, readRegions and | |
| # Zones. | |
| "availableCpuPlatforms": [ # [Output Only] Available cpu/platform selections for the zone. | |
| "A String", | |
| ], | |
| "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 zone. | |
| "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#zone", # Output only. [Output Only] Type of the resource. Always compute#zone for | |
| # zones. | |
| "name": "A String", # [Output Only] Name of the resource. | |
| "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone. | |
| "resourceStatus": { | |
| "upcomingMaintenances": [ # Output only. [Output Only] The upcoming maintenance schedule. | |
| { # The periodic partial maintenance schedule includes 52 weeks worth of | |
| # maintenance windows. | |
| # LINT.IfChange(PeriodicPartialMaintenanceSchedule) | |
| "subType": "A String", # The maintenance type in which the zone is during the given window. | |
| "targetResource": "A String", # The target resource that the maintenance window is for. | |
| # For example, "projects/my-project/zones/us-central1-a". | |
| "type": "A String", | |
| "windowEndTime": { # Represents civil time (or occasionally physical time). # The end civil timestamp of the window (not inclusive). | |
| # This contains a time zone. | |
| # | |
| # This type can represent a civil time in one of a few possible ways: | |
| # | |
| # * When utc_offset is set and time_zone is unset: a civil time on a calendar | |
| # day with a particular offset from UTC. | |
| # * When time_zone is set and utc_offset is unset: a civil time on a calendar | |
| # day in a particular time zone. | |
| # * When neither time_zone nor utc_offset is set: a civil time on a calendar | |
| # day in local time. | |
| # | |
| # The date is relative to the Proleptic Gregorian Calendar. | |
| # | |
| # If year, month, or day are 0, the DateTime is considered not to have a | |
| # specific year, month, or day respectively. | |
| # | |
| # This type may also be used to represent a physical time if all the date and | |
| # time fields are set and either case of the `time_offset` oneof is set. | |
| # Consider using `Timestamp` message for physical time instead. If your use | |
| # case also would like to store the user's timezone, that can be done in | |
| # another field. | |
| # | |
| # This type is more flexible than some applications may want. Make sure to | |
| # document and validate your application's limitations. | |
| "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and | |
| # month, or 0 if specifying a datetime without a day. | |
| "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults | |
| # to 0 (midnight). An API may choose to allow the value "24:00:00" for | |
| # scenarios like business closing time. | |
| "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. | |
| "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a | |
| # datetime without a month. | |
| "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to | |
| # 999,999,999, defaults to 0. | |
| "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, | |
| # defaults to 0. An API may allow the value 60 if it allows leap-seconds. | |
| "timeZone": { # Represents a time zone from the # Time zone. | |
| # [IANA Time Zone Database](https://www.iana.org/time-zones). | |
| "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York". | |
| "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a". | |
| }, | |
| "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. | |
| # For example, a UTC offset of -4:00 would be represented as | |
| # { seconds: -14400 }. | |
| "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a | |
| # datetime without a year. | |
| }, | |
| "windowStartTime": { # Represents civil time (or occasionally physical time). # The start civil timestamp of the window. | |
| # This contains a time zone. | |
| # | |
| # This type can represent a civil time in one of a few possible ways: | |
| # | |
| # * When utc_offset is set and time_zone is unset: a civil time on a calendar | |
| # day with a particular offset from UTC. | |
| # * When time_zone is set and utc_offset is unset: a civil time on a calendar | |
| # day in a particular time zone. | |
| # * When neither time_zone nor utc_offset is set: a civil time on a calendar | |
| # day in local time. | |
| # | |
| # The date is relative to the Proleptic Gregorian Calendar. | |
| # | |
| # If year, month, or day are 0, the DateTime is considered not to have a | |
| # specific year, month, or day respectively. | |
| # | |
| # This type may also be used to represent a physical time if all the date and | |
| # time fields are set and either case of the `time_offset` oneof is set. | |
| # Consider using `Timestamp` message for physical time instead. If your use | |
| # case also would like to store the user's timezone, that can be done in | |
| # another field. | |
| # | |
| # This type is more flexible than some applications may want. Make sure to | |
| # document and validate your application's limitations. | |
| "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and | |
| # month, or 0 if specifying a datetime without a day. | |
| "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults | |
| # to 0 (midnight). An API may choose to allow the value "24:00:00" for | |
| # scenarios like business closing time. | |
| "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. | |
| "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a | |
| # datetime without a month. | |
| "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to | |
| # 999,999,999, defaults to 0. | |
| "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, | |
| # defaults to 0. An API may allow the value 60 if it allows leap-seconds. | |
| "timeZone": { # Represents a time zone from the # Time zone. | |
| # [IANA Time Zone Database](https://www.iana.org/time-zones). | |
| "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York". | |
| "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a". | |
| }, | |
| "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. | |
| # For example, a UTC offset of -4:00 would be represented as | |
| # { seconds: -14400 }. | |
| "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a | |
| # datetime without a year. | |
| }, | |
| }, | |
| ], | |
| }, | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "status": "A String", # [Output Only] Status of the zone, either UP orDOWN. | |
| "supportsPzs": True or False, # Output only. [Output Only] Reserved for future use. | |
| }, | |
| ], | |
| "kind": "compute#zoneList", # Output only. Type of resource. | |
| "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. [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(previous_request, previous_response)</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> |