Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / cloudbilling_v1.services.skus.html
blob: 9347a03fcae898c611bd95018f27f43c6af0f71f [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="cloudbilling_v1.html">Cloud Billing API</a> . <a href="cloudbilling_v1.services.html">services</a> . <a href="cloudbilling_v1.services.skus.html">skus</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]81 <code><a href="#list">list(parent, startTime=None, currencyCode=None, pageSize=None, pageToken=None, endTime=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Lists all publicly available SKUs for a given cloud service.</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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]93 <code class="details" id="list">list(parent, startTime=None, currencyCode=None, pageSize=None, pageToken=None, endTime=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94 <pre>Lists all publicly available SKUs for a given cloud service.
95
96Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 parent: string, Required. The name of the service. Example: &quot;services/DA34-426B-A397&quot; (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]98 startTime: string, Optional inclusive start time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]99 currencyCode: string, The ISO 4217 currency code for the pricing info in the response proto. Will use the conversion rate as of start_time. Optional. If not specified USD will be used.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]100 pageSize: integer, Requested page size. Defaults to 5000.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]101 pageToken: string, A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListSkus` call. If unspecified, the first page of results is returned.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]102 endTime: string, Optional exclusive end time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
107
108Returns:
109 An object of the form:
110
111 { # Response message for `ListSkus`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]112 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. To retrieve the next page, call `ListSkus` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;skus&quot;: [ # The list of public SKUs of the given service.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 { # Encapsulates a single SKU in Google Cloud Platform
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]115 &quot;description&quot;: &quot;A String&quot;, # A human readable description of the SKU, has a maximum length of 256 characters.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]116 &quot;skuId&quot;: &quot;A String&quot;, # The identifier for the SKU. Example: &quot;AA95-CD31-42FE&quot;
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]117 &quot;geoTaxonomy&quot;: { # Encapsulates the geographic taxonomy data for a sku. # The geographic taxonomy for this sku.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]118 &quot;type&quot;: &quot;A String&quot;, # The type of Geo Taxonomy: GLOBAL, REGIONAL, or MULTI_REGIONAL.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]119 &quot;regions&quot;: [ # The list of regions associated with a sku. Empty for Global skus, which are associated with all Google Cloud regions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]120 &quot;A String&quot;,
121 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]122 },
123 &quot;name&quot;: &quot;A String&quot;, # The resource name for the SKU. Example: &quot;services/DA34-426B-A397/skus/AA95-CD31-42FE&quot;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]124 &quot;category&quot;: { # Represents the category hierarchy of a SKU. # The category hierarchy of this SKU, purely for organizational purpose.
125 &quot;resourceFamily&quot;: &quot;A String&quot;, # The type of product the SKU refers to. Example: &quot;Compute&quot;, &quot;Storage&quot;, &quot;Network&quot;, &quot;ApplicationServices&quot; etc.
126 &quot;serviceDisplayName&quot;: &quot;A String&quot;, # The display name of the service this SKU belongs to.
127 &quot;resourceGroup&quot;: &quot;A String&quot;, # A group classification for related SKUs. Example: &quot;RAM&quot;, &quot;GPU&quot;, &quot;Prediction&quot;, &quot;Ops&quot;, &quot;GoogleEgress&quot; etc.
128 &quot;usageType&quot;: &quot;A String&quot;, # Represents how the SKU is consumed. Example: &quot;OnDemand&quot;, &quot;Preemptible&quot;, &quot;Commit1Mo&quot;, &quot;Commit1Yr&quot; etc.
129 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]130 &quot;pricingInfo&quot;: [ # A timeline of pricing info for this SKU in chronological order.
131 { # Represents the pricing information for a SKU at a single point of time.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]132 &quot;aggregationInfo&quot;: { # Represents the aggregation level and interval for pricing of a single SKU. # Aggregation Info. This can be left unspecified if the pricing expression doesn&#x27;t require aggregation.
133 &quot;aggregationInterval&quot;: &quot;A String&quot;,
134 &quot;aggregationCount&quot;: 42, # The number of intervals to aggregate over. Example: If aggregation_level is &quot;DAILY&quot; and aggregation_count is 14, aggregation will be over 14 days.
135 &quot;aggregationLevel&quot;: &quot;A String&quot;,
136 },
137 &quot;summary&quot;: &quot;A String&quot;, # An optional human readable summary of the pricing information, has a maximum length of 256 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]138 &quot;pricingExpression&quot;: { # Expresses a mathematical pricing formula. For Example:- `usage_unit: GBy` `tiered_rates:` `[start_usage_amount: 20, unit_price: $10]` `[start_usage_amount: 100, unit_price: $5]` The above expresses a pricing formula where the first 20GB is free, the next 80GB is priced at $10 per GB followed by $5 per GB for additional usage. # Expresses the pricing formula. See `PricingExpression` for an example.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]139 &quot;baseUnitDescription&quot;: &quot;A String&quot;, # The base unit in human readable form. Example: &quot;byte&quot;.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]140 &quot;usageUnit&quot;: &quot;A String&quot;, # The short hand for unit of usage this pricing is specified in. Example: usage_unit of &quot;GiBy&quot; means that usage is specified in &quot;Gibi Byte&quot;.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]141 &quot;displayQuantity&quot;: 3.14, # The recommended quantity of units for displaying pricing info. When displaying pricing info it is recommended to display: (unit_price * display_quantity) per display_quantity usage_unit. This field does not affect the pricing formula and is for display purposes only. Example: If the unit_price is &quot;0.0001 USD&quot;, the usage_unit is &quot;GB&quot; and the display_quantity is &quot;1000&quot; then the recommended way of displaying the pricing info is &quot;0.10 USD per 1000 GB&quot;
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]142 &quot;usageUnitDescription&quot;: &quot;A String&quot;, # The unit of usage in human readable form. Example: &quot;gibi byte&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]143 &quot;tieredRates&quot;: [ # The list of tiered rates for this pricing. The total cost is computed by applying each of the tiered rates on usage. This repeated list is sorted by ascending order of start_usage_amount.
144 { # The price rate indicating starting usage and its corresponding price.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]145 &quot;unitPrice&quot;: { # Represents an amount of money with its currency type. # The price per unit of usage. Example: unit_price of amount $10 indicates that each unit will cost $10.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]146 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]147 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]148 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]149 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]150 &quot;startUsageAmount&quot;: 3.14, # Usage is priced at this rate only after this amount. Example: start_usage_amount of 10 indicates that the usage will be priced at the unit_price after the first 10 usage_units.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]151 },
152 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]153 &quot;baseUnitConversionFactor&quot;: 3.14, # Conversion factor for converting from price per usage_unit to price per base_unit, and start_usage_amount to start_usage_amount in base_unit. unit_price / base_unit_conversion_factor = price per base_unit. start_usage_amount * base_unit_conversion_factor = start_usage_amount in base_unit.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]154 &quot;baseUnit&quot;: &quot;A String&quot;, # The base unit for the SKU which is the unit used in usage exports. Example: &quot;By&quot;
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]155 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]156 &quot;currencyConversionRate&quot;: 3.14, # Conversion rate used for currency conversion, from USD to the currency specified in the request. This includes any surcharge collected for billing in non USD currency. If a currency is not specified in the request this defaults to 1.0. Example: USD * currency_conversion_rate = JPY
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]157 &quot;effectiveTime&quot;: &quot;A String&quot;, # The timestamp from which this pricing was effective within the requested time range. This is guaranteed to be greater than or equal to the start_time field in the request and less than the end_time field in the request. If a time range was not specified in the request this field will be equivalent to a time within the last 12 hours, indicating the latest pricing info.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]158 },
159 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]160 &quot;serviceProviderName&quot;: &quot;A String&quot;, # Identifies the service provider. This is &#x27;Google&#x27; for first party services in Google Cloud Platform.
161 &quot;serviceRegions&quot;: [ # List of service regions this SKU is offered at. Example: &quot;asia-east1&quot; Service regions can be found at https://cloud.google.com/about/locations/
162 &quot;A String&quot;,
163 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 },
165 ],
166 }</pre>
167</div>
168
169<div class="method">
170 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
171 <pre>Retrieves the next page of results.
172
173Args:
174 previous_request: The request for the previous page. (required)
175 previous_response: The response from the request for the previous page. (required)
176
177Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]178 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]179 page. Returns None if there are no more items in the collection.
180 </pre>
181</div>
182
183</body></html>