Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / compute_v1.regions.html
blob: b51e25f20df658da9085daf7e5e376568d0da996 [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>
79<p class="firstline">Returns the specified region resource.</p>
80<p class="toc_element">
81 <code><a href="#list">list(project, 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>
89 <pre>Returns the specified region resource.
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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]103 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
104 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]106 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
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.
120 "id": "A String", # [Output Only] Unique identifier for the resource; 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">
127 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
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)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]132 maxResults: integer, Maximum count of results to be returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]133 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
134 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.
135
136The 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 (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.
137
138For example, filter=name ne example-instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]139
140Returns:
141 An object of the form:
142
143 { # Contains a list of region resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]144 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
145 "items": [ # [Output Only] A list of Region resources.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 { # Region resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]147 "status": "A String", # [Output Only] Status of the region, either UP or DOWN.
148 "kind": "compute#region", # [Output Only] Type of the resource. Always compute#region for regions.
149 "description": "A String", # [Output Only] Textual description of the resource.
150 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this region.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]151 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
152 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]153 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]155 "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]156 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]157 "quotas": [ # [Output Only] Quotas assigned to this region.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]158 { # A quotas entry.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]159 "usage": 3.14, # [Output Only] Current usage of this metric.
160 "metric": "A String", # [Output Only] Name of the quota metric.
161 "limit": 3.14, # [Output Only] Quota limit for this metric.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]162 },
163 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]164 "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]165 "A String",
166 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]167 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
168 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server .
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]169 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]170 "name": "A String", # [Output Only] Name of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]171 },
172 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]173 "kind": "compute#regionList", # [Output Only] Type of resource. Always compute#regionList for lists of regions.
174 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]175 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]176 }</pre>
177</div>
178
179<div class="method">
180 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
181 <pre>Retrieves the next page of results.
182
183Args:
184 previous_request: The request for the previous page. (required)
185 previous_response: The response from the request for the previous page. (required)
186
187Returns:
188 A request object that you can call 'execute()' on to request the next
189 page. Returns None if there are no more items in the collection.
190 </pre>
191</div>
192
193</body></html>