Class: OCI::UsageApi::Models::RequestUsageCarbonEmissionsDetails
- Inherits:
-
Object
- Object
- OCI::UsageApi::Models::RequestUsageCarbonEmissionsDetails
- Defined in:
- lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb
Overview
Details for the '/usageCarbonEmissions' query.
Instance Attribute Summary collapse
-
#compartment_depth ⇒ Integer
The compartment depth level.
- #filter ⇒ OCI::UsageApi::Models::Filter
-
#group_by ⇒ Array<String>
Aggregate the result by.
-
#group_by_tag ⇒ Array<OCI::UsageApi::Models::Tag>
GroupBy a specific tagKey.
-
#is_aggregate_by_time ⇒ BOOLEAN
Specifies whether aggregated by time.
-
#tenant_id ⇒ String
[Required] Tenant ID.
-
#time_usage_ended ⇒ DateTime
[Required] The usage end time.
-
#time_usage_started ⇒ DateTime
[Required] The usage start time.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ RequestUsageCarbonEmissionsDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ RequestUsageCarbonEmissionsDetails
Initializes the object
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 96 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.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.
45 46 47 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 45 def compartment_depth @compartment_depth end |
#filter ⇒ OCI::UsageApi::Models::Filter
48 49 50 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 48 def filter @filter 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\"]
34 35 36 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 34 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\"]
41 42 43 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 41 def group_by_tag @group_by_tag end |
#is_aggregate_by_time ⇒ BOOLEAN
Specifies whether aggregated by time. If isAggregateByTime is true, all usage carbon emissions over the query time period will be added up.
25 26 27 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 25 def is_aggregate_by_time @is_aggregate_by_time end |
#tenant_id ⇒ String
[Required] Tenant ID.
13 14 15 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 13 def tenant_id @tenant_id end |
#time_usage_ended ⇒ DateTime
[Required] The usage end time.
21 22 23 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 21 def time_usage_ended @time_usage_ended end |
#time_usage_started ⇒ DateTime
[Required] The usage start time.
17 18 19 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 17 def time_usage_started @time_usage_started end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 51 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'tenant_id': :'tenantId', 'time_usage_started': :'timeUsageStarted', 'time_usage_ended': :'timeUsageEnded', '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.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 67 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'tenant_id': :'String', 'time_usage_started': :'DateTime', 'time_usage_ended': :'DateTime', '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.
156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 156 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 && 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
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 193 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
173 174 175 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 173 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
182 183 184 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 182 def hash [tenant_id, time_usage_started, time_usage_ended, 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
226 227 228 229 230 231 232 233 234 235 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 226 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
220 221 222 |
# File 'lib/oci/usage_api/models/request_usage_carbon_emissions_details.rb', line 220 def to_s to_hash.to_s end |