UsageDimension¶
- class oci.self.models.UsageDimension(**kwargs)¶
Bases:
objectA metered usage dimension associated with a usage-based or hybrid pricing plan.
Attributes:
A constant which can be used with the dimension_billing_frequency property of a UsageDimension.
A constant which can be used with the dimension_billing_frequency property of a UsageDimension.
A constant which can be used with the dimension_billing_frequency property of a UsageDimension.
A constant which can be used with the dimension_billing_frequency property of a UsageDimension.
A constant which can be used with the dimension_billing_frequency property of a UsageDimension.
A constant which can be used with the dimension_billing_frequency property of a UsageDimension.
A constant which can be used with the dimension_billing_frequency property of a UsageDimension.
A constant which can be used with the metric_type property of a UsageDimension.
A constant which can be used with the metric_type property of a UsageDimension.
A constant which can be used with the metric_type property of a UsageDimension.
A constant which can be used with the metric_type property of a UsageDimension.
[Required] Gets the dimension_billing_frequency of this UsageDimension.
[Required] Gets the dimension_description of this UsageDimension.
[Required] Gets the dimension_key of this UsageDimension.
[Required] Gets the dimension_name of this UsageDimension.
Gets the included_quantity of this UsageDimension.
[Required] Gets the metric_type of this UsageDimension.
[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”
- DIMENSION_BILLING_FREQUENCY_YEARLY = 'YEARLY'¶
A constant which can be used with the dimension_billing_frequency property of a UsageDimension. This constant has a value of “YEARLY”
- 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_name (str) – The value to assign to the dimension_name property of this UsageDimension.
dimension_key (str) – The value to assign to the dimension_key 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”, “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”, “YEARLY”, ‘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.
rates (list[oci.self.models.PricingRate]) – The value to assign to the rates property of this UsageDimension.
- property dimension_billing_frequency¶
[Required] Gets the dimension_billing_frequency of this UsageDimension. Specifies the interval at which the usage dimension is billed.
Allowed values for this property are: “MONTHLY”, “QUARTERLY”, “SEMI_ANNUAL”, “ANNUAL”, “BIENNIAL”, “TRIENNIAL”, “YEARLY”, ‘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
- property dimension_description¶
[Required] Gets the dimension_description of this UsageDimension. A detailed explanation of the usage dimension.
- Returns
The dimension_description of this UsageDimension.
- Return type
str
- property dimension_key¶
[Required] Gets the dimension_key of this UsageDimension. The stable key used internally to map this usage dimension to billing details.
- Returns
The dimension_key of this UsageDimension.
- Return type
str
- property dimension_name¶
[Required] Gets the dimension_name of this UsageDimension. The name of the usage dimension.
- Returns
The dimension_name of this UsageDimension.
- Return type
str
- property included_quantity¶
Gets the included_quantity of this UsageDimension. Quantity included in the base fee for hybrid plans.
- Returns
The included_quantity of this UsageDimension.
- Return type
float
- property metric_type¶
[Required] Gets the metric_type of this UsageDimension. The metric type in which usage is measured.
Allowed values for this property are: “OCPU_HOURS”, “INSTANCE_HOURS”, “CORE_HOURS”, “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
- property rates¶
[Required] Gets the rates of this UsageDimension. Dimension-level rates in various supported currencies.
- Returns
The rates of this UsageDimension.
- Return type