Reference documentation and code samples for the Google Cloud Billing V1 Client class PricingExpression.
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.
Generated from protobuf message google.cloud.billing.v1.PricingExpression
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ usage_unit |
string
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". |
↳ display_quantity |
float
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" |
↳ tiered_rates |
array<Google\Cloud\Billing\V1\PricingExpression\TierRate>
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. |
↳ usage_unit_description |
string
The unit of usage in human readable form. Example: "gibi byte". |
↳ base_unit |
string
The base unit for the SKU which is the unit used in usage exports. Example: "By" |
↳ base_unit_description |
string
The base unit in human readable form. Example: "byte". |
↳ base_unit_conversion_factor |
float
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. |
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 | |
|---|---|
| Type | Description |
string | |
setUsageUnit
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".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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 | |
|---|---|
| Type | Description |
float | |
setDisplayQuantity
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"
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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 | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setTieredRates
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Billing\V1\PricingExpression\TierRate>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUsageUnitDescription
The unit of usage in human readable form.
Example: "gibi byte".
| Returns | |
|---|---|
| Type | Description |
string | |
setUsageUnitDescription
The unit of usage in human readable form.
Example: "gibi byte".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBaseUnit
The base unit for the SKU which is the unit used in usage exports.
Example: "By"
| Returns | |
|---|---|
| Type | Description |
string | |
setBaseUnit
The base unit for the SKU which is the unit used in usage exports.
Example: "By"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBaseUnitDescription
The base unit in human readable form.
Example: "byte".
| Returns | |
|---|---|
| Type | Description |
string | |
setBaseUnitDescription
The base unit in human readable form.
Example: "byte".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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 | |
|---|---|
| Type | Description |
float | |
setBaseUnitConversionFactor
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.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |