Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0e2843ccaf8cac7f90ef64e9ad883596da8ce4f4 / . / docs / dyn / compute_v1beta14.zones.html
blob: 7e46c27361108f385bc7f41a003eb1c372d8b42d [file] [log] [blame]
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500[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_v1beta14.html">Compute Engine API</a> . <a href="compute_v1beta14.zones.html">zones</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(project, zone)</a></code></p>
79<p class="firstline">Returns the specified zone 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 zone 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, zone)</code>
89 <pre>Returns the specified zone resource.
90
91Args:
92 project: string, Name of the project scoping this request. (required)
93 zone: string, Name of the zone resource to return. (required)
94
95Returns:
96 An object of the form:
97
98 { # A zone resource.
99 "status": "A String", # Status of the zone. "UP" or "DOWN".
100 "kind": "compute#zone", # Type of the resource.
101 "availableMachineType": [ # The machine types that can be used in this zone (output only).
102 "A String",
103 ],
104 "description": "A String", # Textual description of the resource.
105 "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
106 {
107 "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
108 "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
109 "name": "A String", # Name of the maintenance window.
110 "description": "A String", # Textual description of the maintenance window.
111 },
112 ],
113 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this zone.
114 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
115 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
116 "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.
117 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
118 "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.
119 },
120 "quotas": [ # Quotas assigned to this zone.
121 { # A quotas entry.
122 "usage": 3.14, # Current usage of this metric.
123 "metric": "A String", # Name of the quota metric.
124 "limit": 3.14, # Quota limit for this metric.
125 },
126 ],
127 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
128 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
129 "selfLink": "A String", # Server defined URL for the resource (output only).
130 "name": "A String", # Name of the resource.
131 }</pre>
132</div>
133
134<div class="method">
135 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
136 <pre>Retrieves the list of zone resources available to the specified project.
137
138Args:
139 project: string, Name of the project scoping this request. (required)
140 maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
141 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
142 filter: string, Optional. Filter expression for filtering listed resources.
143
144Returns:
145 An object of the form:
146
147 { # Contains a list of zone resources.
148 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
149 "items": [ # The zone resources.
150 { # A zone resource.
151 "status": "A String", # Status of the zone. "UP" or "DOWN".
152 "kind": "compute#zone", # Type of the resource.
153 "availableMachineType": [ # The machine types that can be used in this zone (output only).
154 "A String",
155 ],
156 "description": "A String", # Textual description of the resource.
157 "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
158 {
159 "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
160 "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
161 "name": "A String", # Name of the maintenance window.
162 "description": "A String", # Textual description of the maintenance window.
163 },
164 ],
165 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this zone.
166 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
167 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
168 "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.
169 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
170 "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.
171 },
172 "quotas": [ # Quotas assigned to this zone.
173 { # A quotas entry.
174 "usage": 3.14, # Current usage of this metric.
175 "metric": "A String", # Name of the quota metric.
176 "limit": 3.14, # Quota limit for this metric.
177 },
178 ],
179 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
180 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
181 "selfLink": "A String", # Server defined URL for the resource (output only).
182 "name": "A String", # Name of the resource.
183 },
184 ],
185 "kind": "compute#zoneList", # Type of resource.
186 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
187 "selfLink": "A String", # Server defined URL for this resource (output only).
188 }</pre>
189</div>
190
191<div class="method">
192 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
193 <pre>Retrieves the next page of results.
194
195Args:
196 previous_request: The request for the previous page. (required)
197 previous_response: The response from the request for the previous page. (required)
198
199Returns:
200 A request object that you can call 'execute()' on to request the next
201 page. Returns None if there are no more items in the collection.
202 </pre>
203</div>
204
205</body></html>