class OCI::UsageApi::Models::QueryDefinition

The common fields for queries.

Attributes

cost_analysis_ui[RW]

This attribute is required. @return [OCI::UsageApi::Models::CostAnalysisUI]

display_name[RW]

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

report_query[RW]

This attribute is required. @return [OCI::UsageApi::Models::ReportQuery]

version[RW]

[Required] The saved query version. @return [Float]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/usage_api/models/query_definition.rb, line 27
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [OCI::UsageApi::Models::ReportQuery] :report_query The value to assign to the {#report_query} property @option attributes [OCI::UsageApi::Models::CostAnalysisUI] :cost_analysis_ui The value to assign to the {#cost_analysis_ui} property @option attributes [Float] :version The value to assign to the {#version} property

# File lib/oci/usage_api/models/query_definition.rb, line 60
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/usage_api/models/query_definition.rb, line 39
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'report_query': :'OCI::UsageApi::Models::ReportQuery',
    'cost_analysis_ui': :'OCI::UsageApi::Models::CostAnalysisUI',
    'version': :'Float'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/usage_api/models/query_definition.rb, line 94
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/usage_api/models/query_definition.rb, line 127
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/usage_api/models/query_definition.rb, line 107
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/usage_api/models/query_definition.rb, line 116
def hash
  [display_name, report_query, cost_analysis_ui, version].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/usage_api/models/query_definition.rb, line 160
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/usage_api/models/query_definition.rb, line 154
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/usage_api/models/query_definition.rb, line 177
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end