Class: OCI::UsageApi::Models::UsageCarbonEmissionsQueryDefinition

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

Overview

The common fields for queries.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UsageCarbonEmissionsQueryDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/usage_api/models/usage_carbon_emissions_query_definition.rb', line 61

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.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.report_query = attributes[:'reportQuery'] if attributes[:'reportQuery']

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

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

  self.cost_analysis_ui = attributes[:'costAnalysisUI'] if attributes[:'costAnalysisUI']

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

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

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

Instance Attribute Details

#cost_analysis_ui ⇒ OCI::UsageApi::Models::CostAnalysisUI

This attribute is required.

Returns:



21
22
23
 
# File 'lib/oci/usage_api/models/usage_carbon_emissions_query_definition.rb', line 21

def cost_analysis_ui
  @cost_analysis_ui
end

#display_name ⇒ String

[Required] The query display name. Avoid entering confidential information.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/usage_api/models/usage_carbon_emissions_query_definition.rb', line 13

def display_name
  @display_name
end

#report_query ⇒ OCI::UsageApi::Models::UsageCarbonEmissionsReportQuery

This attribute is required.

Returns:



17
18
19
 
# File 'lib/oci/usage_api/models/usage_carbon_emissions_query_definition.rb', line 17

def report_query
  @report_query
end

#version ⇒ Integer

[Required] The saved query version.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/oci/usage_api/models/usage_carbon_emissions_query_definition.rb', line 25

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/oci/usage_api/models/usage_carbon_emissions_query_definition.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'report_query': :'reportQuery',
    'cost_analysis_ui': :'costAnalysisUI',
    'version': :'version'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/usage_api/models/usage_carbon_emissions_query_definition.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'report_query': :'OCI::UsageApi::Models::UsageCarbonEmissionsReportQuery',
    'cost_analysis_ui': :'OCI::UsageApi::Models::CostAnalysisUI',
    'version': :'Integer'
    # 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



95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/usage_api/models/usage_carbon_emissions_query_definition.rb', line 95

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

  self.class == other.class &&
    display_name == other.display_name &&
    report_query == other.report_query &&
    cost_analysis_ui == other.cost_analysis_ui &&
    version == other.version
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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/usage_api/models/usage_carbon_emissions_query_definition.rb', line 128

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


108
109
110
 
# File 'lib/oci/usage_api/models/usage_carbon_emissions_query_definition.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/usage_api/models/usage_carbon_emissions_query_definition.rb', line 117

def hash
  [display_name, report_query, cost_analysis_ui, version].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/usage_api/models/usage_carbon_emissions_query_definition.rb', line 161

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



155
156
157
 
# File 'lib/oci/usage_api/models/usage_carbon_emissions_query_definition.rb', line 155

def to_s
  to_hash.to_s
end