Blame - docs/dyn/cloudbilling_v1.services.skus.html - platform/external/python/google-api-python-client

2020-07-22 17:02:09 -0700

[diff] [blame^]

78

<code><a href="#list">list(parent, endTime=None, currencyCode=None, pageSize=None, startTime=None, pageToken=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Lists all publicly available SKUs for a given cloud service.</p>

80

81

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

82

<p class="firstline">Retrieves the next page of results.</p>

83

<h3>Method Details</h3>

84

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

85

<code class="details" id="list">list(parent, endTime=None, currencyCode=None, pageSize=None, startTime=None, pageToken=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

86

<pre>Lists all publicly available SKUs for a given cloud service.

87

88

Args:

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

89

parent: string, Required. The name of the service.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

90

Example: "services/DA34-426B-A397" (required)

91

endTime: string, Optional exclusive end time of the time range for which the pricing

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

versions will be returned. Timestamps in the future are not allowed.

93

The time range has to be within a single calendar month in

94

America/Los_Angeles timezone. Time range as a whole is optional. If not

95

specified, the latest pricing will be returned (up to 12 hours old at

96

most).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

97

currencyCode: string, The ISO 4217 currency code for the pricing info in the response proto.

98

Will use the conversion rate as of start_time.

99

Optional. If not specified USD will be used.

100

pageSize: integer, Requested page size. Defaults to 5000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

101

startTime: string, Optional inclusive start time of the time range for which the pricing

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

102

versions will be returned. Timestamps in the future are not allowed.

103

The time range has to be within a single calendar month in

104

America/Los_Angeles timezone. Time range as a whole is optional. If not

105

specified, the latest pricing will be returned (up to 12 hours old at

106

most).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

107

pageToken: string, A token identifying a page of results to return. This should be a

108

`next_page_token` value returned from a previous `ListSkus`

109

call. If unspecified, the first page of results is returned.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

110

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

117

118

{ # Response message for `ListSkus`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

119

"skus": [ # The list of public SKUs of the given service.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

120

{ # Encapsulates a single SKU in Google Cloud Platform

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

121

"skuId": "A String", # The identifier for the SKU.

122

# Example: "AA95-CD31-42FE"

123

"category": { # Represents the category hierarchy of a SKU. # The category hierarchy of this SKU, purely for organizational purpose.

124

"serviceDisplayName": "A String", # The display name of the service this SKU belongs to.

125

"resourceGroup": "A String", # A group classification for related SKUs.

126

# Example: "RAM", "GPU", "Prediction", "Ops", "GoogleEgress" etc.

127

"resourceFamily": "A String", # The type of product the SKU refers to.

128

# Example: "Compute", "Storage", "Network", "ApplicationServices" etc.

129

"usageType": "A String", # Represents how the SKU is consumed.

130

# Example: "OnDemand", "Preemptible", "Commit1Mo", "Commit1Yr" etc.

131

},

132

"serviceProviderName": "A String", # Identifies the service provider.

133

# This is 'Google' for first party services in Google Cloud Platform.

134

"description": "A String", # A human readable description of the SKU, has a maximum length of 256

135

# characters.

136

"serviceRegions": [ # List of service regions this SKU is offered at.

137

# Example: "asia-east1"

138

# Service regions can be found at https://cloud.google.com/about/locations/

139

"A String",

140

],

141

"name": "A String", # The resource name for the SKU.

142

# Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE"

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

143

"pricingInfo": [ # A timeline of pricing info for this SKU in chronological order.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

144

{ # Represents the pricing information for a SKU at a single point of time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

145

"effectiveTime": "A String", # The timestamp from which this pricing was effective within the requested

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

146

# time range. This is guaranteed to be greater than or equal to the

147

# start_time field in the request and less than the end_time field in the

148

# request. If a time range was not specified in the request this field will

149

# be equivalent to a time within the last 12 hours, indicating the latest

150

# pricing info.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

151

"summary": "A String", # An optional human readable summary of the pricing information, has a

152

# maximum length of 256 characters.

153

"aggregationInfo": { # Represents the aggregation level and interval for pricing of a single SKU. # Aggregation Info. This can be left unspecified if the pricing expression

154

# doesn't require aggregation.

155

"aggregationCount": 42, # The number of intervals to aggregate over.

156

# Example: If aggregation_level is "DAILY" and aggregation_count is 14,

157

# aggregation will be over 14 days.

158

"aggregationInterval": "A String",

159

"aggregationLevel": "A String",

160

},

161

"currencyConversionRate": 3.14, # Conversion rate used for currency conversion, from USD to the currency

162

# specified in the request. This includes any surcharge collected for billing

163

# in non USD currency. If a currency is not specified in the request this

164

# defaults to 1.0.

165

# Example: USD * currency_conversion_rate = JPY

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

166

"pricingExpression": { # Expresses a mathematical pricing formula. For Example:- # Expresses the pricing formula. See `PricingExpression` for an example.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# `usage_unit: GBy`

# `tiered_rates:`

# `[start_usage_amount: 20, unit_price: $10]`

171

# `[start_usage_amount: 100, unit_price: $5]`

172

#

173

# The above expresses a pricing formula where the first 20GB is free, the

174

# next 80GB is priced at $10 per GB followed by $5 per GB for additional

175

# usage.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

176

"baseUnitDescription": "A String", # The base unit in human readable form.

177

# Example: "byte".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

178

"tieredRates": [ # The list of tiered rates for this pricing. The total cost is computed by

179

# applying each of the tiered rates on usage. This repeated list is sorted

180

# by ascending order of start_usage_amount.

181

{ # The price rate indicating starting usage and its corresponding price.

182

"unitPrice": { # Represents an amount of money with its currency type. # The price per unit of usage.

183

# Example: unit_price of amount $10 indicates that each unit will cost $10.

184

"nanos": 42, # Number of nano (10^-9) units of the amount.

185

# The value must be between -999,999,999 and +999,999,999 inclusive.

186

# If `units` is positive, `nanos` must be positive or zero.

187

# If `units` is zero, `nanos` can be positive, zero, or negative.

188

# If `units` is negative, `nanos` must be negative or zero.

189

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

190

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

191

"units": "A String", # The whole units of the amount.

192

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

193

},

194

"startUsageAmount": 3.14, # Usage is priced at this rate only after this amount.

195

# Example: start_usage_amount of 10 indicates that the usage will be priced

196

# at the unit_price after the first 10 usage_units.

197

},

198

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

199

"usageUnit": "A String", # The short hand for unit of usage this pricing is specified in.

200

# Example: usage_unit of "GiBy" means that usage is specified in "Gibi Byte".

201

"displayQuantity": 3.14, # The recommended quantity of units for displaying pricing info. When

202

# displaying pricing info it is recommended to display:

203

# (unit_price * display_quantity) per display_quantity usage_unit.

204

# This field does not affect the pricing formula and is for display purposes

205

# only.

206

# Example: If the unit_price is "0.0001 USD", the usage_unit is "GB" and

207

# the display_quantity is "1000" then the recommended way of displaying the

208

# pricing info is "0.10 USD per 1000 GB"

209

"usageUnitDescription": "A String", # The unit of usage in human readable form.

210

# Example: "gibi byte".

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

211

"baseUnitConversionFactor": 3.14, # Conversion factor for converting from price per usage_unit to price per

212

# base_unit, and start_usage_amount to start_usage_amount in base_unit.

213

# unit_price / base_unit_conversion_factor = price per base_unit.

214

# start_usage_amount * base_unit_conversion_factor = start_usage_amount in

215

# base_unit.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

216

"baseUnit": "A String", # The base unit for the SKU which is the unit used in usage exports.

217

# Example: "By"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

218

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

219

},

220

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

221

"geoTaxonomy": { # Encapsulates the geographic taxonomy data for a sku. # The geographic taxonomy for this sku.

222

"type": "A String", # The type of Geo Taxonomy: GLOBAL, REGIONAL, or MULTI_REGIONAL.

223

"regions": [ # The list of regions associated with a sku. Empty for Global skus, which are

224

# associated with all GCP regions.

225

"A String",

226

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

227

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

228

},

229

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

230

"nextPageToken": "A String", # A token to retrieve the next page of results. To retrieve the next page,

231

# call `ListSkus` again with the `page_token` field set to this

232

# value. This field is empty if there are no more results to retrieve.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

238

<pre>Retrieves the next page of results.

239

240

Args:

241

previous_request: The request for the previous page. (required)

242

previous_response: The response from the request for the previous page. (required)

243

244

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

245

A request object that you can call 'execute()' on to request the next

Bu Sun Kim