Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_beta.regions.html
blob: 7794cbca40cbdf17a230369340bbf8b01a8425d1 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.regions.html">regions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(project, region)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Returns the specified Region resource. Gets a list of available regions by making a list() request.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
82<p class="firstline">Retrieves the list of region resources available to the specified project.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(project, region)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89 <pre>Returns the specified Region resource. Gets a list of available regions by making a list() request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]90
91Args:
92 project: string, Project ID for this request. (required)
93 region: string, Name of the region resource to return. (required)
94
95Returns:
96 An object of the form:
97
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 { # Represents a Region resource.
99 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]100 # A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for {$api_version}.regions ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]101 "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
102 "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
103 "description": "A String", # [Output Only] Textual description of the resource.
104 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this region.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]105 "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.
106 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107 "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 use ACTIVE. 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]108 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]109 "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.
110 },
111 "quotas": [ # [Output Only] Quotas assigned to this region.
112 { # A quotas entry.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113 "owner": "A String", # [Output Only] Owning resource. This is the resource on which this quota is applied.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]114 "usage": 3.14, # [Output Only] Current usage of this metric.
115 "metric": "A String", # [Output Only] Name of the quota metric.
116 "limit": 3.14, # [Output Only] Quota limit for this metric.
117 },
118 ],
119 "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
120 "A String",
121 ],
122 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
123 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
124 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
125 "name": "A String", # [Output Only] Name of the resource.
126 }</pre>
127</div>
128
129<div class="method">
130 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
131 <pre>Retrieves the list of region resources available to the specified project.
132
133Args:
134 project: string, Project ID for this request. (required)
135 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
136
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]137You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]138
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]139Currently, only sorting by `name` or `creationTimestamp desc` is supported.
140 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`)
141 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.
142 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]143
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]144For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]145
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]146You 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 on resource labels.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]147
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]148To 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) ```
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]149
150Returns:
151 An object of the form:
152
153 { # Contains a list of region resources.
154 "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 than maxResults, 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 "kind": "compute#regionList", # [Output Only] Type of resource. Always compute#regionList for lists of regions.
156 "items": [ # A list of Region resources.
157 { # Represents a Region resource.
158 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]159 # A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for {$api_version}.regions ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]160 "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
161 "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
162 "description": "A String", # [Output Only] Textual description of the resource.
163 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this region.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]164 "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.
165 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 "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 use ACTIVE. 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]167 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]168 "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.
169 },
170 "quotas": [ # [Output Only] Quotas assigned to this region.
171 { # A quotas entry.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 "owner": "A String", # [Output Only] Owning resource. This is the resource on which this quota is applied.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]173 "usage": 3.14, # [Output Only] Current usage of this metric.
174 "metric": "A String", # [Output Only] Name of the quota metric.
175 "limit": 3.14, # [Output Only] Quota limit for this metric.
176 },
177 ],
178 "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
179 "A String",
180 ],
181 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
182 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
183 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
184 "name": "A String", # [Output Only] Name of the resource.
185 },
186 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]187 "warning": { # [Output Only] Informational warning message.
188 "message": "A String", # [Output Only] A human-readable description of the warning code.
189 "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.
190 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
191 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
192 {
193 "value": "A String", # [Output Only] A warning data value corresponding to the key.
194 "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).
195 },
196 ],
197 },
198 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]199 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
200 }</pre>
201</div>
202
203<div class="method">
204 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
205 <pre>Retrieves the next page of results.
206
207Args:
208 previous_request: The request for the previous page. (required)
209 previous_response: The response from the request for the previous page. (required)
210
211Returns:
212 A request object that you can call 'execute()' on to request the next
213 page. Returns None if there are no more items in the collection.
214 </pre>
215</div>
216
217</body></html>