Class: OCI::MarketplacePublisher::Models::Pricing

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/marketplace_publisher/models/pricing.rb

Overview

the pricing information for the offer

Constant Summary collapse

BILLING_CYCLE_ENUM = 
[
  BILLING_CYCLE_ONE_TIME = 'ONE_TIME'.freeze,
  BILLING_CYCLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Pricing

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :currency_type (String) —

    The value to assign to the #currency_type property

  • :total_amount (Integer) —

    The value to assign to the #total_amount property

  • :billing_cycle (String) —

    The value to assign to the #billing_cycle property



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/marketplace_publisher/models/pricing.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.currency_type = attributes[:'currencyType'] if attributes[:'currencyType']

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

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

  self.total_amount = attributes[:'totalAmount'] if attributes[:'totalAmount']

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

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

  self.billing_cycle = attributes[:'billingCycle'] if attributes[:'billingCycle']

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

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

Instance Attribute Details

#billing_cycle ⇒ String

The frequency at which the customer is billed for the Offer

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/marketplace_publisher/models/pricing.rb', line 27

def billing_cycle
  @billing_cycle
end

#currency_type ⇒ String

The currency supported for a given Offer, in the format specified by ISO-4217

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/marketplace_publisher/models/pricing.rb', line 19

def currency_type
  @currency_type
end

#total_amount ⇒ Integer

The total amount an Offer costs

Returns:

  • (Integer) 


23
24
25
 
# File 'lib/oci/marketplace_publisher/models/pricing.rb', line 23

def total_amount
  @total_amount
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/marketplace_publisher/models/pricing.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'currency_type': :'currencyType',
    'total_amount': :'totalAmount',
    'billing_cycle': :'billingCycle'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'currency_type': :'String',
    'total_amount': :'Integer',
    'billing_cycle': :'String'
    # 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



105
106
107
108
109
110
111
112
 
# File 'lib/oci/marketplace_publisher/models/pricing.rb', line 105

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

  self.class == other.class &&
    currency_type == other.currency_type &&
    total_amount == other.total_amount &&
    billing_cycle == other.billing_cycle
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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/marketplace_publisher/models/pricing.rb', line 137

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


117
118
119
 
# File 'lib/oci/marketplace_publisher/models/pricing.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



126
127
128
 
# File 'lib/oci/marketplace_publisher/models/pricing.rb', line 126

def hash
  [currency_type, total_amount, billing_cycle].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/marketplace_publisher/models/pricing.rb', line 170

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



164
165
166
 
# File 'lib/oci/marketplace_publisher/models/pricing.rb', line 164

def to_s
  to_hash.to_s
end