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