Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / compute_beta.regions.html
blob: cde8e4fd4f3c6448d774db5e516b88a208ca5c9e [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]81 <code><a href="#get">get(project, region)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<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]83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]84 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]85<p class="firstline">Retrieves the list of region resources available to the specified project.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]96 <code class="details" id="get">get(project, region)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97 <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]98
99Args:
100 project: string, Project ID for this request. (required)
101 region: string, Name of the region resource to return. (required)
102
103Returns:
104 An object of the form:
105
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 { # Represents a Region resource.
107 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]108 # A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for {$api_version}.regions ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
110 &quot;deprecated&quot;: { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this region.
111 &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.
112 &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.
113 &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.
114 &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.
115 &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 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]116 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 &quot;description&quot;: &quot;A String&quot;, # [Output Only] Textual description of the resource.
118 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
119 &quot;kind&quot;: &quot;compute#region&quot;, # [Output Only] Type of the resource. Always compute#region for regions.
120 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
121 &quot;quotas&quot;: [ # [Output Only] Quotas assigned to this region.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]122 { # A quotas entry.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 &quot;limit&quot;: 3.14, # [Output Only] Quota limit for this metric.
124 &quot;metric&quot;: &quot;A String&quot;, # [Output Only] Name of the quota metric.
125 &quot;owner&quot;: &quot;A String&quot;, # [Output Only] Owning resource. This is the resource on which this quota is applied.
126 &quot;usage&quot;: 3.14, # [Output Only] Current usage of this metric.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]127 },
128 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]129 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
130 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Status of the region, either UP or DOWN.
131 &quot;zones&quot;: [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
132 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]133 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]134 }</pre>
135</div>
136
137<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]138 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]139 <pre>Retrieves the list of region resources available to the specified project.
140
141Args:
142 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]143 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]144
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]145For 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]146
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]147You 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]148
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149To 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) ```
150 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`)
151 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
152
153You 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.
154
155Currently, only sorting by `name` or `creationTimestamp desc` is supported.
156 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]157 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]158
159Returns:
160 An object of the form:
161
162 { # Contains a list of region resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
164 &quot;items&quot;: [ # A list of Region resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 { # Represents a Region resource.
166 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]167 # A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for {$api_version}.regions ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]168 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
169 &quot;deprecated&quot;: { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this region.
170 &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.
171 &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.
172 &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.
173 &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.
174 &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 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]175 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 &quot;description&quot;: &quot;A String&quot;, # [Output Only] Textual description of the resource.
177 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
178 &quot;kind&quot;: &quot;compute#region&quot;, # [Output Only] Type of the resource. Always compute#region for regions.
179 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
180 &quot;quotas&quot;: [ # [Output Only] Quotas assigned to this region.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]181 { # A quotas entry.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182 &quot;limit&quot;: 3.14, # [Output Only] Quota limit for this metric.
183 &quot;metric&quot;: &quot;A String&quot;, # [Output Only] Name of the quota metric.
184 &quot;owner&quot;: &quot;A String&quot;, # [Output Only] Owning resource. This is the resource on which this quota is applied.
185 &quot;usage&quot;: 3.14, # [Output Only] Current usage of this metric.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]186 },
187 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]188 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
189 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Status of the region, either UP or DOWN.
190 &quot;zones&quot;: [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
191 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]192 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]193 },
194 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]195 &quot;kind&quot;: &quot;compute#regionList&quot;, # [Output Only] Type of resource. Always compute#regionList for lists of regions.
196 &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 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.
197 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
198 &quot;warning&quot;: { # [Output Only] Informational warning message.
199 &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.
200 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
201 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]203 &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).
204 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 },
206 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]207 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]208 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]209 }</pre>
210</div>
211
212<div class="method">
213 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
214 <pre>Retrieves the next page of results.
215
216Args:
217 previous_request: The request for the previous page. (required)
218 previous_response: The response from the request for the previous page. (required)
219
220Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]222 page. Returns None if there are no more items in the collection.
223 </pre>
224</div>
225
226</body></html>