UsageDimension¶

class oci.marketplace_publisher.models.UsageDimension(**kwargs)¶

Bases: object

Usage dimension for usage-based or hybrid SaaS pricing.

Attributes

`DIMENSION_BILLING_FREQUENCY_ANNUAL`	A constant which can be used with the dimension_billing_frequency property of a UsageDimension.
`DIMENSION_BILLING_FREQUENCY_BIENNIAL`	A constant which can be used with the dimension_billing_frequency property of a UsageDimension.
`DIMENSION_BILLING_FREQUENCY_MONTHLY`	A constant which can be used with the dimension_billing_frequency property of a UsageDimension.
`DIMENSION_BILLING_FREQUENCY_QUARTERLY`	A constant which can be used with the dimension_billing_frequency property of a UsageDimension.
`DIMENSION_BILLING_FREQUENCY_SEMI_ANNUAL`	A constant which can be used with the dimension_billing_frequency property of a UsageDimension.
`DIMENSION_BILLING_FREQUENCY_TRIENNIAL`	A constant which can be used with the dimension_billing_frequency property of a UsageDimension.
`METRIC_TYPE_AMOUNT`	A constant which can be used with the metric_type property of a UsageDimension.
`METRIC_TYPE_CORE_HOURS`	A constant which can be used with the metric_type property of a UsageDimension.
`METRIC_TYPE_EACH`	A constant which can be used with the metric_type property of a UsageDimension.
`METRIC_TYPE_INSTANCE_HOURS`	A constant which can be used with the metric_type property of a UsageDimension.
`METRIC_TYPE_OCPU_HOURS`	A constant which can be used with the metric_type property of a UsageDimension.
`additional_details`	Gets the additional_details of this UsageDimension.
`dimension_billing_frequency`	[Required] Gets the dimension_billing_frequency of this UsageDimension.
`dimension_description`	[Required] Gets the dimension_description of this UsageDimension.
`dimension_key`	Gets the dimension_key of this UsageDimension.
`dimension_name`	[Required] Gets the dimension_name of this UsageDimension.
`included_quantity`	Gets the included_quantity of this UsageDimension.
`metric_type`	[Required] Gets the metric_type of this UsageDimension.
`rates`	[Required] Gets the rates of this UsageDimension.

Methods

__init__(**kwargs) Initializes a new UsageDimension object with values from keyword arguments.

DIMENSION_BILLING_FREQUENCY_ANNUAL = 'ANNUAL'¶: A constant which can be used with the dimension_billing_frequency property of a UsageDimension. This constant has a value of “ANNUAL”

DIMENSION_BILLING_FREQUENCY_BIENNIAL = 'BIENNIAL'¶: A constant which can be used with the dimension_billing_frequency property of a UsageDimension. This constant has a value of “BIENNIAL”

DIMENSION_BILLING_FREQUENCY_MONTHLY = 'MONTHLY'¶: A constant which can be used with the dimension_billing_frequency property of a UsageDimension. This constant has a value of “MONTHLY”

DIMENSION_BILLING_FREQUENCY_QUARTERLY = 'QUARTERLY'¶: A constant which can be used with the dimension_billing_frequency property of a UsageDimension. This constant has a value of “QUARTERLY”

DIMENSION_BILLING_FREQUENCY_SEMI_ANNUAL = 'SEMI_ANNUAL'¶: A constant which can be used with the dimension_billing_frequency property of a UsageDimension. This constant has a value of “SEMI_ANNUAL”

DIMENSION_BILLING_FREQUENCY_TRIENNIAL = 'TRIENNIAL'¶: A constant which can be used with the dimension_billing_frequency property of a UsageDimension. This constant has a value of “TRIENNIAL”

METRIC_TYPE_AMOUNT = 'AMOUNT'¶: A constant which can be used with the metric_type property of a UsageDimension. This constant has a value of “AMOUNT”

METRIC_TYPE_CORE_HOURS = 'CORE_HOURS'¶: A constant which can be used with the metric_type property of a UsageDimension. This constant has a value of “CORE_HOURS”

METRIC_TYPE_EACH = 'EACH'¶: A constant which can be used with the metric_type property of a UsageDimension. This constant has a value of “EACH”

METRIC_TYPE_INSTANCE_HOURS = 'INSTANCE_HOURS'¶: A constant which can be used with the metric_type property of a UsageDimension. This constant has a value of “INSTANCE_HOURS”

METRIC_TYPE_OCPU_HOURS = 'OCPU_HOURS'¶: A constant which can be used with the metric_type property of a UsageDimension. This constant has a value of “OCPU_HOURS”

__init__(**kwargs)¶

Initializes a new UsageDimension object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

dimension_key (str) – The value to assign to the dimension_key property of this UsageDimension.
dimension_name (str) – The value to assign to the dimension_name property of this UsageDimension.
dimension_description (str) – The value to assign to the dimension_description property of this UsageDimension.
metric_type (str) – The value to assign to the metric_type property of this UsageDimension. Allowed values for this property are: “OCPU_HOURS”, “INSTANCE_HOURS”, “CORE_HOURS”, “AMOUNT”, “EACH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
dimension_billing_frequency (str) – The value to assign to the dimension_billing_frequency property of this UsageDimension. Allowed values for this property are: “MONTHLY”, “QUARTERLY”, “SEMI_ANNUAL”, “ANNUAL”, “BIENNIAL”, “TRIENNIAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
included_quantity (float) – The value to assign to the included_quantity property of this UsageDimension.
additional_details (dict(str, str)) – The value to assign to the additional_details property of this UsageDimension.
rates (list[oci.marketplace_publisher.models.PricingRate]) – The value to assign to the rates property of this UsageDimension.

additional_details¶

Gets the additional_details of this UsageDimension. Additional metadata key/value pairs for the dimension.

Returns:	The additional_details of this UsageDimension.
Return type:	dict(str, str)

dimension_billing_frequency¶

[Required] Gets the dimension_billing_frequency of this UsageDimension. Billing frequency used for the dimension.

Allowed values for this property are: “MONTHLY”, “QUARTERLY”, “SEMI_ANNUAL”, “ANNUAL”, “BIENNIAL”, “TRIENNIAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The dimension_billing_frequency of this UsageDimension.
Return type:	str

dimension_description¶

[Required] Gets the dimension_description of this UsageDimension. The dimension description.

Returns:	The dimension_description of this UsageDimension.
Return type:	str

dimension_key¶

Gets the dimension_key of this UsageDimension. Server-generated unique identifier for the usage dimension. If omitted in the request, it is generated automatically.

Returns:	The dimension_key of this UsageDimension.
Return type:	str

dimension_name¶

[Required] Gets the dimension_name of this UsageDimension. The dimension name.

Returns:	The dimension_name of this UsageDimension.
Return type:	str

included_quantity¶

Gets the included_quantity of this UsageDimension. Included quantity before overage rates apply.

Returns:	The included_quantity of this UsageDimension.
Return type:	float

metric_type¶

[Required] Gets the metric_type of this UsageDimension. The metric type used to measure usage for the dimension.

Allowed values for this property are: “OCPU_HOURS”, “INSTANCE_HOURS”, “CORE_HOURS”, “AMOUNT”, “EACH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The metric_type of this UsageDimension.
Return type:	str

rates¶

[Required] Gets the rates of this UsageDimension. List of pricing rates provider by publisher for the dimension.

Returns:	The rates of this UsageDimension.
Return type:	list[oci.marketplace_publisher.models.PricingRate]