Class: OCI::Usage::Models::ProductSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/usage/models/product_summary.rb

Overview

Provides details about product rewards and the usage amount.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProductSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :product_number (String) —

    The value to assign to the #product_number property

  • :product_name (String) —

    The value to assign to the #product_name property

  • :usage_amount (Float) —

    The value to assign to the #usage_amount property

  • :earned_rewards (Float) —

    The value to assign to the #earned_rewards property

  • :is_eligible_to_earn_rewards (BOOLEAN) —

    The value to assign to the #is_eligible_to_earn_rewards property

[View source]

68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/usage/models/product_summary.rb', line 68

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

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

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

  self.product_name = attributes[:'productName'] if attributes[:'productName']

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

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

  self.usage_amount = attributes[:'usageAmount'] if attributes[:'usageAmount']

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

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

  self.earned_rewards = attributes[:'earnedRewards'] if attributes[:'earnedRewards']

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

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

  self.is_eligible_to_earn_rewards = attributes[:'isEligibleToEarnRewards'] unless attributes[:'isEligibleToEarnRewards'].nil?

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

  self.is_eligible_to_earn_rewards = attributes[:'is_eligible_to_earn_rewards'] unless attributes[:'is_eligible_to_earn_rewards'].nil?
end

Instance Attribute Details

#earned_rewards ⇒ Float

The earned rewards for the product.

Returns:

  • (Float) 

25
26
27
 
# File 'lib/oci/usage/models/product_summary.rb', line 25

def earned_rewards
  @earned_rewards
end

#is_eligible_to_earn_rewards ⇒ BOOLEAN

The boolean parameter to indicate if the product is eligible to earn rewards.

Returns:

  • (BOOLEAN) 

29
30
31
 
# File 'lib/oci/usage/models/product_summary.rb', line 29

def is_eligible_to_earn_rewards
  @is_eligible_to_earn_rewards
end

#product_name ⇒ String

The rate card product name.

Returns:

  • (String) 

17
18
19
 
# File 'lib/oci/usage/models/product_summary.rb', line 17

def product_name
  @product_name
end

#product_number ⇒ String

The rate card product number.

Returns:

  • (String) 

13
14
15
 
# File 'lib/oci/usage/models/product_summary.rb', line 13

def product_number
  @product_number
end

#usage_amount ⇒ Float

The rate card product usage amount.

Returns:

  • (Float) 

21
22
23
 
# File 'lib/oci/usage/models/product_summary.rb', line 21

def usage_amount
  @usage_amount
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/usage/models/product_summary.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'product_number': :'productNumber',
    'product_name': :'productName',
    'usage_amount': :'usageAmount',
    'earned_rewards': :'earnedRewards',
    'is_eligible_to_earn_rewards': :'isEligibleToEarnRewards'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/usage/models/product_summary.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'product_number': :'String',
    'product_name': :'String',
    'usage_amount': :'Float',
    'earned_rewards': :'Float',
    'is_eligible_to_earn_rewards': :'BOOLEAN'
    # 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

[View source]

112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/usage/models/product_summary.rb', line 112

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

  self.class == other.class &&
    product_number == other.product_number &&
    product_name == other.product_name &&
    usage_amount == other.usage_amount &&
    earned_rewards == other.earned_rewards &&
    is_eligible_to_earn_rewards == other.is_eligible_to_earn_rewards
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

[View source]

146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/usage/models/product_summary.rb', line 146

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
[View source]

126
127
128
 
# File 'lib/oci/usage/models/product_summary.rb', line 126

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

135
136
137
 
# File 'lib/oci/usage/models/product_summary.rb', line 135

def hash
  [product_number, product_name, usage_amount, earned_rewards, is_eligible_to_earn_rewards].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/usage/models/product_summary.rb', line 179

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

[View source]

173
174
175
 
# File 'lib/oci/usage/models/product_summary.rb', line 173

def to_s
  to_hash.to_s
end