Class: OCI::TenantManagerControlPlane::Models::Order

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/tenant_manager_control_plane/models/order.rb

Overview

Order details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Order

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/tenant_manager_control_plane/models/order.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.order_number = attributes[:'orderNumber'] if attributes[:'orderNumber']

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

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

  self.data_center_region = attributes[:'dataCenterRegion'] if attributes[:'dataCenterRegion']

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

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

  self.admin_email = attributes[:'adminEmail'] if attributes[:'adminEmail']

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

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

  self.order_state = attributes[:'orderState'] if attributes[:'orderState']

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

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

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

Instance Attribute Details

#admin_email ⇒ String

[Required] Email address of the administrator who owns the subscription.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/tenant_manager_control_plane/models/order.rb', line 21

def admin_email
  @admin_email
end

#data_center_region ⇒ String

Order's data center region.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/tenant_manager_control_plane/models/order.rb', line 17

def data_center_region
  @data_center_region
end

#order_number ⇒ String

[Required] Immutable and unique order number holding customer subscription information.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/tenant_manager_control_plane/models/order.rb', line 13

def order_number
  @order_number
end

#order_state ⇒ String

[Required] State of the order.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/tenant_manager_control_plane/models/order.rb', line 25

def order_state
  @order_state
end

#subscriptions ⇒ Array<OCI::TenantManagerControlPlane::Models::SubscriptionInfo>

[Required] Array of subscriptions associated with the order.

Returns:



29
30
31
 
# File 'lib/oci/tenant_manager_control_plane/models/order.rb', line 29

def subscriptions
  @subscriptions
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'order_number': :'orderNumber',
    'data_center_region': :'dataCenterRegion',
    'admin_email': :'adminEmail',
    'order_state': :'orderState',
    'subscriptions': :'subscriptions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'order_number': :'String',
    'data_center_region': :'String',
    'admin_email': :'String',
    'order_state': :'String',
    'subscriptions': :'Array<OCI::TenantManagerControlPlane::Models::SubscriptionInfo>'
    # 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



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/tenant_manager_control_plane/models/order.rb', line 108

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

  self.class == other.class &&
    order_number == other.order_number &&
    data_center_region == other.data_center_region &&
    admin_email == other.admin_email &&
    order_state == other.order_state &&
    subscriptions == other.subscriptions
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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/tenant_manager_control_plane/models/order.rb', line 142

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


122
123
124
 
# File 'lib/oci/tenant_manager_control_plane/models/order.rb', line 122

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



131
132
133
 
# File 'lib/oci/tenant_manager_control_plane/models/order.rb', line 131

def hash
  [order_number, data_center_region, admin_email, order_state, subscriptions].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/tenant_manager_control_plane/models/order.rb', line 175

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



169
170
171
 
# File 'lib/oci/tenant_manager_control_plane/models/order.rb', line 169

def to_s
  to_hash.to_s
end