Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / compute_v1.regionCommitments.html
blob: 198e4e77dd01b33d9d6459dab8b9868975296759 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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.regionCommitments.html">regionCommitments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
79<p class="firstline">Retrieves an aggregated list of commitments.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
84 <code><a href="#get">get(project, region, commitment)</a></code></p>
85<p class="firstline">Returns the specified commitment resource. Gets a list of available commitments by making a list() request.</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p>
88<p class="firstline">Creates a commitment in the specified project using the data included in the request.</p>
89<p class="toc_element">
90 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
91<p class="firstline">Retrieves a list of commitments contained within the specified region.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
98 <pre>Retrieves an aggregated list of commitments.
99
100Args:
101 project: string, Project ID for this request. (required)
102 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
103
104You 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.
105
106Currently, only sorting by name or creationTimestamp desc is supported.
107 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
108 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.
109 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
110
111For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
112
113You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
114
115To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
116
117Returns:
118 An object of the form:
119
120 {
121 "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.
122 "kind": "compute#commitmentAggregatedList", # [Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments.
123 "items": { # A list of CommitmentsScopedList resources.
124 "a_key": { # [Output Only] Name of the scope containing this set of commitments.
125 "warning": { # [Output Only] Informational warning which replaces the list of commitments when the list is empty.
126 "message": "A String", # [Output Only] A human-readable description of the warning code.
127 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
128 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
129 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
130 {
131 "value": "A String", # [Output Only] A warning data value corresponding to the key.
132 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
133 },
134 ],
135 },
136 "commitments": [ # [Output Only] A list of commitments contained in this scope.
137 { # Represents a regional Commitment resource.
138 #
139 # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==)
140 "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
141 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
142 "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
143 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
144 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
145 "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.
146 "region": "A String", # [Output Only] URL of the region where this commitment may be used.
147 "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
148 "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
149 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
150 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
151 "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
152 { # Commitment for a particular resource (a Commitment is composed of one or more of these).
153 "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
154 "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU and MEMORY
155 },
156 ],
157 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
158 },
159 ],
160 },
161 },
162 "warning": { # [Output Only] Informational warning message.
163 "message": "A String", # [Output Only] A human-readable description of the warning code.
164 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
165 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
166 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
167 {
168 "value": "A String", # [Output Only] A warning data value corresponding to the key.
169 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
170 },
171 ],
172 },
173 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
174 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
175 }</pre>
176</div>
177
178<div class="method">
179 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
180 <pre>Retrieves the next page of results.
181
182Args:
183 previous_request: The request for the previous page. (required)
184 previous_response: The response from the request for the previous page. (required)
185
186Returns:
187 A request object that you can call 'execute()' on to request the next
188 page. Returns None if there are no more items in the collection.
189 </pre>
190</div>
191
192<div class="method">
193 <code class="details" id="get">get(project, region, commitment)</code>
194 <pre>Returns the specified commitment resource. Gets a list of available commitments by making a list() request.
195
196Args:
197 project: string, Project ID for this request. (required)
198 region: string, Name of the region for this request. (required)
199 commitment: string, Name of the commitment to return. (required)
200
201Returns:
202 An object of the form:
203
204 { # Represents a regional Commitment resource.
205 #
206 # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==)
207 "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
208 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
209 "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
210 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
211 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
212 "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.
213 "region": "A String", # [Output Only] URL of the region where this commitment may be used.
214 "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
215 "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
216 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
217 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
218 "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
219 { # Commitment for a particular resource (a Commitment is composed of one or more of these).
220 "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
221 "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU and MEMORY
222 },
223 ],
224 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
225 }</pre>
226</div>
227
228<div class="method">
229 <code class="details" id="insert">insert(project, region, body, requestId=None)</code>
230 <pre>Creates a commitment in the specified project using the data included in the request.
231
232Args:
233 project: string, Project ID for this request. (required)
234 region: string, Name of the region for this request. (required)
235 body: object, The request body. (required)
236 The object takes the form of:
237
238{ # Represents a regional Commitment resource.
239 #
240 # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==)
241 "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
242 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
243 "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
244 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
245 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
246 "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.
247 "region": "A String", # [Output Only] URL of the region where this commitment may be used.
248 "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
249 "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
250 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
251 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
252 "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
253 { # Commitment for a particular resource (a Commitment is composed of one or more of these).
254 "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
255 "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU and MEMORY
256 },
257 ],
258 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
259 }
260
261 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
262
263For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
264
265The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
266
267Returns:
268 An object of the form:
269
270 { # Represents an Operation resource.
271 #
272 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
273 #
274 # Operations can be global, regional or zonal.
275 # - For global operations, use the globalOperations resource.
276 # - For regional operations, use the regionOperations resource.
277 # - For zonal operations, use the zonalOperations resource.
278 #
279 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
280 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
281 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
282 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
283 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
284 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
285 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
286 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
287 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
288 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
289 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
290 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
291 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
292 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
293 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
294 {
295 "message": "A String", # [Output Only] A human-readable description of the warning code.
296 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
297 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
298 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
299 {
300 "value": "A String", # [Output Only] A warning data value corresponding to the key.
301 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
302 },
303 ],
304 },
305 ],
306 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
307 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
308 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
309 "name": "A String", # [Output Only] Name of the resource.
310 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
311 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
312 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
313 {
314 "message": "A String", # [Output Only] An optional, human-readable error message.
315 "code": "A String", # [Output Only] The error type identifier for this error.
316 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
317 },
318 ],
319 },
320 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
321 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
322 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
323 }</pre>
324</div>
325
326<div class="method">
327 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
328 <pre>Retrieves a list of commitments contained within the specified region.
329
330Args:
331 project: string, Project ID for this request. (required)
332 region: string, Name of the region for this request. (required)
333 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
334
335You 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.
336
337Currently, only sorting by name or creationTimestamp desc is supported.
338 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
339 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.
340 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
341
342For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
343
344You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
345
346To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
347
348Returns:
349 An object of the form:
350
351 { # Contains a list of Commitment resources.
352 "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.
353 "kind": "compute#commitmentList", # [Output Only] Type of resource. Always compute#commitmentList for lists of commitments.
354 "items": [ # A list of Commitment resources.
355 { # Represents a regional Commitment resource.
356 #
357 # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==)
358 "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
359 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
360 "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
361 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
362 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
363 "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.
364 "region": "A String", # [Output Only] URL of the region where this commitment may be used.
365 "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
366 "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
367 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
368 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
369 "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
370 { # Commitment for a particular resource (a Commitment is composed of one or more of these).
371 "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
372 "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU and MEMORY
373 },
374 ],
375 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
376 },
377 ],
378 "warning": { # [Output Only] Informational warning message.
379 "message": "A String", # [Output Only] A human-readable description of the warning code.
380 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
381 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
382 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
383 {
384 "value": "A String", # [Output Only] A warning data value corresponding to the key.
385 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
386 },
387 ],
388 },
389 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
390 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
391 }</pre>
392</div>
393
394<div class="method">
395 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
396 <pre>Retrieves the next page of results.
397
398Args:
399 previous_request: The request for the previous page. (required)
400 previous_response: The response from the request for the previous page. (required)
401
402Returns:
403 A request object that you can call 'execute()' on to request the next
404 page. Returns None if there are no more items in the collection.
405 </pre>
406</div>
407
408</body></html>