Class: OCI::UsageApi::Models::RequestUsageCarbonEmissionsDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb

Overview

Details for the '/usageCarbonEmissions' query.

Constant Summary collapse

EMISSION_CALCULATION_METHOD_ENUM = 
[
  EMISSION_CALCULATION_METHOD_SPEND_BASED = 'SPEND_BASED'.freeze,
  EMISSION_CALCULATION_METHOD_POWER_BASED = 'POWER_BASED'.freeze,
  EMISSION_CALCULATION_METHOD_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
EMISSION_TYPE_ENUM = 
[
  EMISSION_TYPE_MARKET_BASED = 'MARKET_BASED'.freeze,
  EMISSION_TYPE_LOCATION_BASED = 'LOCATION_BASED'.freeze,
  EMISSION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
GRANULARITY_ENUM = 
[
  GRANULARITY_DAILY = 'DAILY'.freeze,
  GRANULARITY_MONTHLY = 'MONTHLY'.freeze,
  GRANULARITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestUsageCarbonEmissionsDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 136

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.tenant_id = attributes[:'tenantId'] if attributes[:'tenantId']

  raise 'You cannot provide both :tenantId and :tenant_id' if attributes.key?(:'tenantId') && attributes.key?(:'tenant_id')

  self.tenant_id = attributes[:'tenant_id'] if attributes[:'tenant_id']

  self.time_usage_started = attributes[:'timeUsageStarted'] if attributes[:'timeUsageStarted']

  raise 'You cannot provide both :timeUsageStarted and :time_usage_started' if attributes.key?(:'timeUsageStarted') && attributes.key?(:'time_usage_started')

  self.time_usage_started = attributes[:'time_usage_started'] if attributes[:'time_usage_started']

  self.time_usage_ended = attributes[:'timeUsageEnded'] if attributes[:'timeUsageEnded']

  raise 'You cannot provide both :timeUsageEnded and :time_usage_ended' if attributes.key?(:'timeUsageEnded') && attributes.key?(:'time_usage_ended')

  self.time_usage_ended = attributes[:'time_usage_ended'] if attributes[:'time_usage_ended']

  self.emission_calculation_method = attributes[:'emissionCalculationMethod'] if attributes[:'emissionCalculationMethod']
  self.emission_calculation_method = "SPEND_BASED" if emission_calculation_method.nil? && !attributes.key?(:'emissionCalculationMethod') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :emissionCalculationMethod and :emission_calculation_method' if attributes.key?(:'emissionCalculationMethod') && attributes.key?(:'emission_calculation_method')

  self.emission_calculation_method = attributes[:'emission_calculation_method'] if attributes[:'emission_calculation_method']
  self.emission_calculation_method = "SPEND_BASED" if emission_calculation_method.nil? && !attributes.key?(:'emissionCalculationMethod') && !attributes.key?(:'emission_calculation_method') # rubocop:disable Style/StringLiterals

  self.emission_type = attributes[:'emissionType'] if attributes[:'emissionType']
  self.emission_type = "MARKET_BASED" if emission_type.nil? && !attributes.key?(:'emissionType') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :emissionType and :emission_type' if attributes.key?(:'emissionType') && attributes.key?(:'emission_type')

  self.emission_type = attributes[:'emission_type'] if attributes[:'emission_type']
  self.emission_type = "MARKET_BASED" if emission_type.nil? && !attributes.key?(:'emissionType') && !attributes.key?(:'emission_type') # rubocop:disable Style/StringLiterals

  self.granularity = attributes[:'granularity'] if attributes[:'granularity']
  self.granularity = "MONTHLY" if granularity.nil? && !attributes.key?(:'granularity') # rubocop:disable Style/StringLiterals

  self.is_aggregate_by_time = attributes[:'isAggregateByTime'] unless attributes[:'isAggregateByTime'].nil?
  self.is_aggregate_by_time = false if is_aggregate_by_time.nil? && !attributes.key?(:'isAggregateByTime') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isAggregateByTime and :is_aggregate_by_time' if attributes.key?(:'isAggregateByTime') && attributes.key?(:'is_aggregate_by_time')

  self.is_aggregate_by_time = attributes[:'is_aggregate_by_time'] unless attributes[:'is_aggregate_by_time'].nil?
  self.is_aggregate_by_time = false if is_aggregate_by_time.nil? && !attributes.key?(:'isAggregateByTime') && !attributes.key?(:'is_aggregate_by_time') # rubocop:disable Style/StringLiterals

  self.group_by = attributes[:'groupBy'] if attributes[:'groupBy']

  raise 'You cannot provide both :groupBy and :group_by' if attributes.key?(:'groupBy') && attributes.key?(:'group_by')

  self.group_by = attributes[:'group_by'] if attributes[:'group_by']

  self.group_by_tag = attributes[:'groupByTag'] if attributes[:'groupByTag']

  raise 'You cannot provide both :groupByTag and :group_by_tag' if attributes.key?(:'groupByTag') && attributes.key?(:'group_by_tag')

  self.group_by_tag = attributes[:'group_by_tag'] if attributes[:'group_by_tag']

  self.compartment_depth = attributes[:'compartmentDepth'] if attributes[:'compartmentDepth']

  raise 'You cannot provide both :compartmentDepth and :compartment_depth' if attributes.key?(:'compartmentDepth') && attributes.key?(:'compartment_depth')

  self.compartment_depth = attributes[:'compartment_depth'] if attributes[:'compartment_depth']

  self.filter = attributes[:'filter'] if attributes[:'filter']
end

Instance Attribute Details

#compartment_depth ⇒ Integer

The compartment depth level.

Returns:

  • (Integer) 


76
77
78
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 76

def compartment_depth
  @compartment_depth
end

#emission_calculation_method ⇒ String

Specifies the method used for emission calculation, such as POWER_BASED or SPEND_BASED

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 44

def emission_calculation_method
  @emission_calculation_method
end

#emission_type ⇒ String

Specifies the type of emission, such as MARKET_BASED or LOCATION_BASED.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 48

def emission_type
  @emission_type
end

#filter ⇒ OCI::UsageApi::Models::Filter

Returns:



79
80
81
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 79

def filter
  @filter
end

#granularity ⇒ String

The carbon emission granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 52

def granularity
  @granularity
end

#group_by ⇒ Array<String>

Aggregate the result by. For example: [\"tagNamespace\", \"tagKey\", \"tagValue\", \"service\", \"skuName\", \"skuPartNumber\", \"unit\", \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\", \"resourceId\", \"resourceName\", \"tenantId\", \"tenantName\", \"subscriptionId\"]

Returns:

  • (Array<String>) 


65
66
67
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 65

def group_by
  @group_by
end

#group_by_tag ⇒ Array<OCI::UsageApi::Models::Tag>

GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: [{\"namespace\":\"oracle\", \"key\":\"createdBy\"]

Returns:



72
73
74
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 72

def group_by_tag
  @group_by_tag
end

#is_aggregate_by_time ⇒ BOOLEAN

Specifies whether aggregated by time. If isAggregateByTime is true, all carbon emissions usage over the query time period are summed.

Returns:

  • (BOOLEAN) 


56
57
58
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 56

def is_aggregate_by_time
  @is_aggregate_by_time
end

#tenant_id ⇒ String

[Required] Tenant ID.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 32

def tenant_id
  @tenant_id
end

#time_usage_ended ⇒ DateTime

[Required] The usage end time.

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 40

def time_usage_ended
  @time_usage_ended
end

#time_usage_started ⇒ DateTime

[Required] The usage start time.

Returns:

  • (DateTime) 


36
37
38
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 36

def time_usage_started
  @time_usage_started
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 82

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    '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',
    'compartment_depth': :'compartmentDepth',
    'filter': :'filter'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 101

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'tenant_id': :'String',
    'time_usage_started': :'DateTime',
    'time_usage_ended': :'DateTime',
    'emission_calculation_method': :'String',
    'emission_type': :'String',
    'granularity': :'String',
    'is_aggregate_by_time': :'BOOLEAN',
    'group_by': :'Array<String>',
    'group_by_tag': :'Array<OCI::UsageApi::Models::Tag>',
    'compartment_depth': :'Integer',
    'filter': :'OCI::UsageApi::Models::Filter'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 254

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    tenant_id == other.tenant_id &&
    time_usage_started == other.time_usage_started &&
    time_usage_ended == other.time_usage_ended &&
    emission_calculation_method == other.emission_calculation_method &&
    emission_type == other.emission_type &&
    granularity == other.granularity &&
    is_aggregate_by_time == other.is_aggregate_by_time &&
    group_by == other.group_by &&
    group_by_tag == other.group_by_tag &&
    compartment_depth == other.compartment_depth &&
    filter == other.filter
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 294

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


274
275
276
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 274

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



283
284
285
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 283

def hash
  [tenant_id, time_usage_started, time_usage_ended, emission_calculation_method, emission_type, granularity, is_aggregate_by_time, group_by, group_by_tag, compartment_depth, filter].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



327
328
329
330
331
332
333
334
335
336
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 327

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



321
322
323
 
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 321

def to_s
  to_hash.to_s
end