Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / compute_v1.regions.html
blob: 5945c8e0204a7121be9a43414714e13c0109819e [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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_v1.html">Compute Engine API</a> . <a href="compute_v1.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>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]79<p class="firstline">Returns the specified Region resource. Get a list of available regions by making a list() request.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]81 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]89 <pre>Returns the specified Region resource. Get a list of available regions by making a list() request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]90
91Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]92 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]93 region: string, Name of the region resource to return. (required)
94
95Returns:
96 An object of the form:
97
98 { # Region resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]99 "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
100 "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
101 "description": "A String", # [Output Only] Textual description of the resource.
102 "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^]103 "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.
104 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]105 "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. 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^]106 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]107 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]108 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]109 "quotas": [ # [Output Only] Quotas assigned to this region.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]110 { # A quotas entry.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]111 "usage": 3.14, # [Output Only] Current usage of this metric.
112 "metric": "A String", # [Output Only] Name of the quota metric.
113 "limit": 3.14, # [Output Only] Quota limit for this metric.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]114 },
115 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]116 "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]117 "A String",
118 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]119 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]120 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]121 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]122 "name": "A String", # [Output Only] Name of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]123 }</pre>
124</div>
125
126<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]127 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 <pre>Retrieves the list of region resources available to the specified project.
129
130Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]131 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]132 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
133
134You 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.
135
136Currently, only sorting by name or creationTimestamp desc is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]137 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.
138 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.
139 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]140
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]141The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]142
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]143For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]144
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]145You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]146
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]147To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]148
149Returns:
150 An object of the form:
151
152 { # Contains a list of region resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]153 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]154 "items": [ # [Output Only] A list of Region resources.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155 { # Region resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]156 "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
157 "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
158 "description": "A String", # [Output Only] Textual description of the resource.
159 "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^]160 "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.
161 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]162 "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. 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^]163 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]164 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]165 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]166 "quotas": [ # [Output Only] Quotas assigned to this region.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]167 { # A quotas entry.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]168 "usage": 3.14, # [Output Only] Current usage of this metric.
169 "metric": "A String", # [Output Only] Name of the quota metric.
170 "limit": 3.14, # [Output Only] Quota limit for this metric.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]171 },
172 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]173 "zones": [ # [Output Only] A list of zones available in this region, in the form of resource URLs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]174 "A String",
175 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]176 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]177 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]178 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]179 "name": "A String", # [Output Only] Name of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]180 },
181 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]182 "kind": "compute#regionList", # [Output Only] Type of resource. Always compute#regionList for lists of regions.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]183 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]184 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]185 }</pre>
186</div>
187
188<div class="method">
189 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
190 <pre>Retrieves the next page of results.
191
192Args:
193 previous_request: The request for the previous page. (required)
194 previous_response: The response from the request for the previous page. (required)
195
196Returns:
197 A request object that you can call 'execute()' on to request the next
198 page. Returns None if there are no more items in the collection.
199 </pre>
200</div>
201
202</body></html>