Class: OCI::Onesubscription::Models::Commitment

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/onesubscription/models/commitment.rb

Overview

Subscribed Service commitment summary

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Commitment

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :subscribed_service_id (String) —

    The value to assign to the #subscribed_service_id property

  • :time_start (DateTime) —

    The value to assign to the #time_start property

  • :time_end (DateTime) —

    The value to assign to the #time_end property

  • :quantity (String) —

    The value to assign to the #quantity property

  • :used_amount (String) —

    The value to assign to the #used_amount property

  • :available_amount (String) —

    The value to assign to the #available_amount property

  • :funded_allocation_value (String) —

    The value to assign to the #funded_allocation_value property



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
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 100

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

  self.subscribed_service_id = attributes[:'subscribedServiceId'] if attributes[:'subscribedServiceId']

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

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

  self.time_start = attributes[:'timeStart'] if attributes[:'timeStart']

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

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

  self.time_end = attributes[:'timeEnd'] if attributes[:'timeEnd']

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

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

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

  self.used_amount = attributes[:'usedAmount'] if attributes[:'usedAmount']

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

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

  self.available_amount = attributes[:'availableAmount'] if attributes[:'availableAmount']

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

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

  self.funded_allocation_value = attributes[:'fundedAllocationValue'] if attributes[:'fundedAllocationValue']

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

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

Instance Attribute Details

#available_amount ⇒ String

Commitment available amount

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 46

def available_amount
  @available_amount
end

#funded_allocation_value ⇒ String

Funded Allocation line value example: 12000.00

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 52

def funded_allocation_value
  @funded_allocation_value
end

#id ⇒ String

[Required] SPM internal Commitment ID

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 16

def id
  @id
end

#quantity ⇒ String

Commitment quantity

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 36

def quantity
  @quantity
end

#subscribed_service_id ⇒ String

SPM internal Subscribed Service ID

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 21

def subscribed_service_id
  @subscribed_service_id
end

#time_end ⇒ DateTime

Commitment end date

Returns:

  • (DateTime) 


31
32
33
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 31

def time_end
  @time_end
end

#time_start ⇒ DateTime

Commitment start date

Returns:

  • (DateTime) 


26
27
28
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 26

def time_start
  @time_start
end

#used_amount ⇒ String

Commitment used amount

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 41

def used_amount
  @used_amount
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'subscribed_service_id': :'subscribedServiceId',
    'time_start': :'timeStart',
    'time_end': :'timeEnd',
    'quantity': :'quantity',
    'used_amount': :'usedAmount',
    'available_amount': :'availableAmount',
    'funded_allocation_value': :'fundedAllocationValue'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 71

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'subscribed_service_id': :'String',
    'time_start': :'DateTime',
    'time_end': :'DateTime',
    'quantity': :'String',
    'used_amount': :'String',
    'available_amount': :'String',
    'funded_allocation_value': :'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



154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 154

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

  self.class == other.class &&
    id == other.id &&
    subscribed_service_id == other.subscribed_service_id &&
    time_start == other.time_start &&
    time_end == other.time_end &&
    quantity == other.quantity &&
    used_amount == other.used_amount &&
    available_amount == other.available_amount &&
    funded_allocation_value == other.funded_allocation_value
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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 191

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


171
172
173
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 171

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



180
181
182
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 180

def hash
  [id, subscribed_service_id, time_start, time_end, quantity, used_amount, available_amount, funded_allocation_value].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 224

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



218
219
220
 
# File 'lib/oci/onesubscription/models/commitment.rb', line 218

def to_s
  to_hash.to_s
end