Class: OCI::Onesubscription::Models::SubscriptionSummary

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

Overview

Subscription summary

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



97
98
99
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
 
# File 'lib/oci/onesubscription/models/subscription_summary.rb', line 97

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

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

  self.service_name = attributes[:'serviceName'] if attributes[:'serviceName']

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

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

  self.hold_reason = attributes[:'holdReason'] if attributes[:'holdReason']

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

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

  self.time_hold_release_eta = attributes[:'timeHoldReleaseEta'] if attributes[:'timeHoldReleaseEta']

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

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

  self.subscribed_services = attributes[:'subscribedServices'] if attributes[:'subscribedServices']

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

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

Instance Attribute Details

#currency ⇒ OCI::Onesubscription::Models::SubscriptionCurrency

Returns:



29
30
31
 
# File 'lib/oci/onesubscription/models/subscription_summary.rb', line 29

def currency
  @currency
end

#hold_reason ⇒ String

Hold reason of the plan

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/onesubscription/models/subscription_summary.rb', line 39

def hold_reason
  @hold_reason
end

#service_name ⇒ String

Customer friendly service name provided by PRG

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/onesubscription/models/subscription_summary.rb', line 34

def service_name
  @service_name
end

#status ⇒ String

Status of the plan

Returns:

  • (String) 


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

def status
  @status
end

#subscribed_services ⇒ Array<OCI::Onesubscription::Models::SubscriptionSubscribedService>

List of Subscribed Services of the plan

Returns:



49
50
51
 
# File 'lib/oci/onesubscription/models/subscription_summary.rb', line 49

def subscribed_services
  @subscribed_services
end

#time_end ⇒ DateTime

Represents the date when the last service of the subscription ends

Returns:

  • (DateTime) 


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

def time_end
  @time_end
end

#time_hold_release_eta ⇒ DateTime

Represents the date of the hold release

Returns:

  • (DateTime) 


44
45
46
 
# File 'lib/oci/onesubscription/models/subscription_summary.rb', line 44

def time_hold_release_eta
  @time_hold_release_eta
end

#time_start ⇒ DateTime

Represents the date when the first service of the subscription was activated

Returns:

  • (DateTime) 


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

def time_start
  @time_start
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/onesubscription/models/subscription_summary.rb', line 52

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'status',
    'time_start': :'timeStart',
    'time_end': :'timeEnd',
    'currency': :'currency',
    'service_name': :'serviceName',
    'hold_reason': :'holdReason',
    'time_hold_release_eta': :'timeHoldReleaseEta',
    'subscribed_services': :'subscribedServices'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/onesubscription/models/subscription_summary.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'String',
    'time_start': :'DateTime',
    'time_end': :'DateTime',
    'currency': :'OCI::Onesubscription::Models::SubscriptionCurrency',
    'service_name': :'String',
    'hold_reason': :'String',
    'time_hold_release_eta': :'DateTime',
    'subscribed_services': :'Array<OCI::Onesubscription::Models::SubscriptionSubscribedService>'
    # 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



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/onesubscription/models/subscription_summary.rb', line 151

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

  self.class == other.class &&
    status == other.status &&
    time_start == other.time_start &&
    time_end == other.time_end &&
    currency == other.currency &&
    service_name == other.service_name &&
    hold_reason == other.hold_reason &&
    time_hold_release_eta == other.time_hold_release_eta &&
    subscribed_services == other.subscribed_services
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



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

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


168
169
170
 
# File 'lib/oci/onesubscription/models/subscription_summary.rb', line 168

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



177
178
179
 
# File 'lib/oci/onesubscription/models/subscription_summary.rb', line 177

def hash
  [status, time_start, time_end, currency, service_name, hold_reason, time_hold_release_eta, subscribed_services].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/onesubscription/models/subscription_summary.rb', line 221

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



215
216
217
 
# File 'lib/oci/onesubscription/models/subscription_summary.rb', line 215

def to_s
  to_hash.to_s
end