class OCI::TenantManagerControlPlane::Models::Order

Order Details for Console plugin display

Attributes

admin_email[RW]

[Required] Admin e-mail owning subscription. @return [String]

data_center_region[RW]

Order's data center region. @return [String]

order_number[RW]

[Required] Immutable and unique order number holding customer subscription information @return [String]

order_state[RW]

[Required] State of order. @return [String]

subscriptions[RW]

[Required] Array of subscriptions associated with the order. @return [Array<OCI::TenantManagerControlPlane::Models::SubscriptionInfo>]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/tenant_manager_control_plane/models/order.rb, line 31
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :order_number The value to assign to the {#order_number} property @option attributes [String] :data_center_region The value to assign to the {#data_center_region} property @option attributes [String] :admin_email The value to assign to the {#admin_email} property @option attributes [String] :order_state The value to assign to the {#order_state} property @option attributes [Array<OCI::TenantManagerControlPlane::Models::SubscriptionInfo>] :subscriptions The value to assign to the {#subscriptions} property

# File lib/oci/tenant_manager_control_plane/models/order.rb, line 67
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/tenant_manager_control_plane/models/order.rb, line 44
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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/tenant_manager_control_plane/models/order.rb, line 107
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/tenant_manager_control_plane/models/order.rb, line 141
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/tenant_manager_control_plane/models/order.rb, line 121
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/tenant_manager_control_plane/models/order.rb, line 130
def hash
  [order_number, data_center_region, admin_email, order_state, subscriptions].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/tenant_manager_control_plane/models/order.rb, line 174
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/tenant_manager_control_plane/models/order.rb, line 168
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/tenant_manager_control_plane/models/order.rb, line 191
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end