Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / compute_v1.regions.html
blob: cf0ee5aa803e306a9420f54777e0737aa8b7b1cd [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:
92 project: string, Name of the project scoping this request. (required)
93 region: string, Name of the region resource to return. (required)
94
95Returns:
96 An object of the form:
97
98 { # Region resource.
99 "status": "A String", # Status of the region, "UP" or "DOWN".
100 "kind": "compute#region", # Type of the resource.
101 "description": "A String", # Textual description of the resource.
102 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this region.
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.
105 "state": "A String", # The deprecation state. 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. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
106 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
107 "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
108 },
109 "quotas": [ # Quotas assigned to this region.
110 { # A quotas entry.
111 "usage": 3.14, # Current usage of this metric.
112 "metric": "A String", # Name of the quota metric.
113 "limit": 3.14, # Quota limit for this metric.
114 },
115 ],
116 "zones": [ # A list of zones homed in this region, in the form of resource URLs.
117 "A String",
118 ],
119 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
120 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
121 "selfLink": "A String", # Server defined URL for the resource (output only).
122 "name": "A String", # Name of the resource.
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:
131 project: string, Name of the project scoping this request. (required)
132 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
133 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
134 filter: string, Optional. Filter expression for filtering listed resources.
135
136Returns:
137 An object of the form:
138
139 { # Contains a list of region resources.
140 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
141 "items": [ # The region resources.
142 { # Region resource.
143 "status": "A String", # Status of the region, "UP" or "DOWN".
144 "kind": "compute#region", # Type of the resource.
145 "description": "A String", # Textual description of the resource.
146 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this region.
147 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
148 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
149 "state": "A String", # The deprecation state. 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. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
150 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
151 "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
152 },
153 "quotas": [ # Quotas assigned to this region.
154 { # A quotas entry.
155 "usage": 3.14, # Current usage of this metric.
156 "metric": "A String", # Name of the quota metric.
157 "limit": 3.14, # Quota limit for this metric.
158 },
159 ],
160 "zones": [ # A list of zones homed in this region, in the form of resource URLs.
161 "A String",
162 ],
163 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
164 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
165 "selfLink": "A String", # Server defined URL for the resource (output only).
166 "name": "A String", # Name of the resource.
167 },
168 ],
169 "kind": "compute#regionList", # Type of resource.
170 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
171 "selfLink": "A String", # Server defined URL for this resource (output only).
172 }</pre>
173</div>
174
175<div class="method">
176 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
177 <pre>Retrieves the next page of results.
178
179Args:
180 previous_request: The request for the previous page. (required)
181 previous_response: The response from the request for the previous page. (required)
182
183Returns:
184 A request object that you can call 'execute()' on to request the next
185 page. Returns None if there are no more items in the collection.
186 </pre>
187</div>
188
189</body></html>