oci 2.152.0__py3-none-any.whl → 2.153.0__py3-none-any.whl

oci/usage_api/models/usage_carbon_emissions_report_query.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class UsageCarbonEmissionsReportQuery(object):
     """
-    The request of the generated usage carbon emissions report.
+    The request of the generated carbon emissions usage report.
     """
 
     #: A constant which can be used with the date_range_name property of a UsageCarbonEmissionsReportQuery.
@@ -52,6 +52,18 @@ class UsageCarbonEmissionsReportQuery(object):
             The value to assign to the time_usage_ended property of this UsageCarbonEmissionsReportQuery.
         :type time_usage_ended: datetime
 
+        :param emission_calculation_method:
+            The value to assign to the emission_calculation_method property of this UsageCarbonEmissionsReportQuery.
+        :type emission_calculation_method: str
+
+        :param emission_type:
+            The value to assign to the emission_type property of this UsageCarbonEmissionsReportQuery.
+        :type emission_type: str
+
+        :param granularity:
+            The value to assign to the granularity property of this UsageCarbonEmissionsReportQuery.
+        :type granularity: str
+
         :param is_aggregate_by_time:
             The value to assign to the is_aggregate_by_time property of this UsageCarbonEmissionsReportQuery.
         :type is_aggregate_by_time: bool
@@ -83,6 +95,9 @@ class UsageCarbonEmissionsReportQuery(object):
             'tenant_id': 'str',
             'time_usage_started': 'datetime',
             'time_usage_ended': 'datetime',
+            'emission_calculation_method': 'str',
+            'emission_type': 'str',
+            'granularity': 'str',
             'is_aggregate_by_time': 'bool',
             'group_by': 'list[str]',
             'group_by_tag': 'list[Tag]',
@@ -94,6 +109,9 @@ class UsageCarbonEmissionsReportQuery(object):
             'tenant_id': 'tenantId',
             'time_usage_started': 'timeUsageStarted',
             'time_usage_ended': 'timeUsageEnded',
+            'emission_calculation_method': 'emissionCalculationMethod',
+            'emission_type': 'emissionType',
+            'granularity': 'granularity',
             'is_aggregate_by_time': 'isAggregateByTime',
             'group_by': 'groupBy',
             'group_by_tag': 'groupByTag',
@@ -104,6 +122,9 @@ class UsageCarbonEmissionsReportQuery(object):
         self._tenant_id = None
         self._time_usage_started = None
         self._time_usage_ended = None
+        self._emission_calculation_method = None
+        self._emission_type = None
+        self._granularity = None
         self._is_aggregate_by_time = None
         self._group_by = None
         self._group_by_tag = None
@@ -183,11 +204,83 @@ class UsageCarbonEmissionsReportQuery(object):
         """
         self._time_usage_ended = time_usage_ended
 
+    @property
+    def emission_calculation_method(self):
+        """
+        Gets the emission_calculation_method of this UsageCarbonEmissionsReportQuery.
+        Specifies the method used for emission calculation, such as POWER_BASED or SPEND_BASED
+
+
+        :return: The emission_calculation_method of this UsageCarbonEmissionsReportQuery.
+        :rtype: str
+        """
+        return self._emission_calculation_method
+
+    @emission_calculation_method.setter
+    def emission_calculation_method(self, emission_calculation_method):
+        """
+        Sets the emission_calculation_method of this UsageCarbonEmissionsReportQuery.
+        Specifies the method used for emission calculation, such as POWER_BASED or SPEND_BASED
+
+
+        :param emission_calculation_method: The emission_calculation_method of this UsageCarbonEmissionsReportQuery.
+        :type: str
+        """
+        self._emission_calculation_method = emission_calculation_method
+
+    @property
+    def emission_type(self):
+        """
+        Gets the emission_type of this UsageCarbonEmissionsReportQuery.
+        Specifies the type of emission, such as MARKET_BASED or LOCATION_BASED.
+
+
+        :return: The emission_type of this UsageCarbonEmissionsReportQuery.
+        :rtype: str
+        """
+        return self._emission_type
+
+    @emission_type.setter
+    def emission_type(self, emission_type):
+        """
+        Sets the emission_type of this UsageCarbonEmissionsReportQuery.
+        Specifies the type of emission, such as MARKET_BASED or LOCATION_BASED.
+
+
+        :param emission_type: The emission_type of this UsageCarbonEmissionsReportQuery.
+        :type: str
+        """
+        self._emission_type = emission_type
+
+    @property
+    def granularity(self):
+        """
+        Gets the granularity of this UsageCarbonEmissionsReportQuery.
+        The carbon emission granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation.
+
+
+        :return: The granularity of this UsageCarbonEmissionsReportQuery.
+        :rtype: str
+        """
+        return self._granularity
+
+    @granularity.setter
+    def granularity(self, granularity):
+        """
+        Sets the granularity of this UsageCarbonEmissionsReportQuery.
+        The carbon emission granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation.
+
+
+        :param granularity: The granularity of this UsageCarbonEmissionsReportQuery.
+        :type: str
+        """
+        self._granularity = granularity
+
     @property
     def is_aggregate_by_time(self):
         """
         Gets the is_aggregate_by_time of this UsageCarbonEmissionsReportQuery.
-        Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up.
+        Specifies whether aggregated by time. If isAggregateByTime is true, all usage or costs over the query time period are summed.
 
 
         :return: The is_aggregate_by_time of this UsageCarbonEmissionsReportQuery.
@@ -199,7 +292,7 @@ class UsageCarbonEmissionsReportQuery(object):
     def is_aggregate_by_time(self, is_aggregate_by_time):
         """
         Sets the is_aggregate_by_time of this UsageCarbonEmissionsReportQuery.
-        Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up.
+        Specifies whether aggregated by time. If isAggregateByTime is true, all usage or costs over the query time period are summed.
 
 
         :param is_aggregate_by_time: The is_aggregate_by_time of this UsageCarbonEmissionsReportQuery.
@@ -315,7 +408,7 @@ class UsageCarbonEmissionsReportQuery(object):
     def date_range_name(self):
         """
         Gets the date_range_name of this UsageCarbonEmissionsReportQuery.
-        The UI date range, for example, LAST_THREE_MONTHS. It will override timeUsageStarted and timeUsageEnded properties.
+        The user interface date range, for example, LAST_THREE_MONTHS. Overrides the timeUsageStarted and timeUsageEnded properties.
 
         Allowed values for this property are: "LAST_TWO_MONTHS", "LAST_THREE_MONTHS", "LAST_SIX_MONTHS", "LAST_ONE_YEAR", "CUSTOM", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -330,7 +423,7 @@ class UsageCarbonEmissionsReportQuery(object):
     def date_range_name(self, date_range_name):
         """
         Sets the date_range_name of this UsageCarbonEmissionsReportQuery.
-        The UI date range, for example, LAST_THREE_MONTHS. It will override timeUsageStarted and timeUsageEnded properties.
+        The user interface date range, for example, LAST_THREE_MONTHS. Overrides the timeUsageStarted and timeUsageEnded properties.
 
 
         :param date_range_name: The date_range_name of this UsageCarbonEmissionsReportQuery.