com.google.api.services.cloudbilling.model

Class PricingExpression

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudbilling.model.PricingExpression

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class PricingExpression
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Billing API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
PricingExpression()

Method Summary

Modifier and Type	Method and Description
PricingExpression	clone()
String	getBaseUnit() The base unit for the SKU which is the unit used in usage exports.
Double	getBaseUnitConversionFactor() 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.
String	getBaseUnitDescription() The base unit in human readable form.
Double	getDisplayQuantity() The recommended quantity of units for displaying pricing info.
List<TierRate>	getTieredRates() The list of tiered rates for this pricing.
String	getUsageUnit() The short hand for unit of usage this pricing is specified in.
String	getUsageUnitDescription() The unit of usage in human readable form.
PricingExpression	set(String fieldName, Object value)
PricingExpression	setBaseUnit(String baseUnit) The base unit for the SKU which is the unit used in usage exports.
PricingExpression	setBaseUnitConversionFactor(Double baseUnitConversionFactor) 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.
PricingExpression	setBaseUnitDescription(String baseUnitDescription) The base unit in human readable form.
PricingExpression	setDisplayQuantity(Double displayQuantity) The recommended quantity of units for displaying pricing info.
PricingExpression	setTieredRates(List<TierRate> tieredRates) The list of tiered rates for this pricing.
PricingExpression	setUsageUnit(String usageUnit) The short hand for unit of usage this pricing is specified in.
PricingExpression	setUsageUnitDescription(String usageUnitDescription) The unit of usage in human readable form.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

PricingExpression

public PricingExpression()

Method Detail

getBaseUnit

public String getBaseUnit()

The base unit for the SKU which is the unit used in usage exports. Example: "By"

Returns:

value or null for none

setBaseUnit

public PricingExpression setBaseUnit(String baseUnit)

The base unit for the SKU which is the unit used in usage exports. Example: "By"

Parameters:

baseUnit - baseUnit or null for none

getBaseUnitConversionFactor

public Double getBaseUnitConversionFactor()

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.

Returns:

value or null for none

setBaseUnitConversionFactor

public PricingExpression setBaseUnitConversionFactor(Double baseUnitConversionFactor)

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.

Parameters:

baseUnitConversionFactor - baseUnitConversionFactor or null for none

getBaseUnitDescription

public String getBaseUnitDescription()

The base unit in human readable form. Example: "byte".

Returns:

value or null for none

setBaseUnitDescription

public PricingExpression setBaseUnitDescription(String baseUnitDescription)

The base unit in human readable form. Example: "byte".

Parameters:

baseUnitDescription - baseUnitDescription or null for none

getDisplayQuantity

public Double getDisplayQuantity()

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 "0.0001 USD", the usage_unit is "GB" and the display_quantity is "1000" then the recommended way of displaying the pricing info is "0.10 USD per 1000 GB"

Returns:

value or null for none

setDisplayQuantity

public PricingExpression setDisplayQuantity(Double displayQuantity)

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 "0.0001 USD", the usage_unit is "GB" and the display_quantity is "1000" then the recommended way of displaying the pricing info is "0.10 USD per 1000 GB"

Parameters:

displayQuantity - displayQuantity or null for none

getTieredRates

public List<TierRate> getTieredRates()

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.

Returns:

value or null for none

setTieredRates

public PricingExpression setTieredRates(List<TierRate> tieredRates)

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.

Parameters:

tieredRates - tieredRates or null for none

getUsageUnit

public String getUsageUnit()

The short hand for unit of usage this pricing is specified in. Example: usage_unit of "GiBy" means that usage is specified in "Gibi Byte".

Returns:

value or null for none

setUsageUnit

public PricingExpression setUsageUnit(String usageUnit)

The short hand for unit of usage this pricing is specified in. Example: usage_unit of "GiBy" means that usage is specified in "Gibi Byte".

Parameters:

usageUnit - usageUnit or null for none

getUsageUnitDescription

public String getUsageUnitDescription()

The unit of usage in human readable form. Example: "gibi byte".

Returns:

value or null for none

setUsageUnitDescription

public PricingExpression setUsageUnitDescription(String usageUnitDescription)

The unit of usage in human readable form. Example: "gibi byte".

Parameters:

usageUnitDescription - usageUnitDescription or null for none

set

public PricingExpression set(String fieldName,
                             Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public PricingExpression clone()

Overrides:

clone in class com.google.api.client.json.GenericJson