Class: OCI::CapacityManagement::Models::OccCustomer

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/capacity_management/models/occ_customer.rb

Overview

The details about the customer.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_DISABLED = 'DISABLED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OccCustomer

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :occ_customer_group_id (String) —

    The value to assign to the #occ_customer_group_id property

  • :tenancy_id (String) —

    The value to assign to the #tenancy_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :status (String) —

    The value to assign to the #status property



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
100
101
102
103
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 75

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

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

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

  self.tenancy_id = attributes[:'tenancyId'] if attributes[:'tenancyId']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  self.status = attributes[:'status'] if attributes[:'status']
  self.status = "ENABLED" if status.nil? && !attributes.key?(:'status') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#description ⇒ String

The description about the customer group.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 32

def description
  @description
end

#display_name ⇒ String

[Required] The display name for the customer

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 28

def display_name
  @display_name
end

#occ_customer_group_id ⇒ String

[Required] The OCID of the customer group.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 20

def occ_customer_group_id
  @occ_customer_group_id
end

#status ⇒ String

[Required] To determine whether the customer is enabled/disabled.`

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 36

def status
  @status
end

#tenancy_id ⇒ String

[Required] The OCID of the tenancy belonging to the customer.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 24

def tenancy_id
  @tenancy_id
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'occ_customer_group_id': :'occCustomerGroupId',
    'tenancy_id': :'tenancyId',
    'display_name': :'displayName',
    'description': :'description',
    'status': :'status'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'occ_customer_group_id': :'String',
    'tenancy_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'status': :'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



125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 125

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

  self.class == other.class &&
    occ_customer_group_id == other.occ_customer_group_id &&
    tenancy_id == other.tenancy_id &&
    display_name == other.display_name &&
    description == other.description &&
    status == other.status
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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 159

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


139
140
141
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 139

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



148
149
150
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 148

def hash
  [occ_customer_group_id, tenancy_id, display_name, description, status].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 192

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



186
187
188
 
# File 'lib/oci/capacity_management/models/occ_customer.rb', line 186

def to_s
  to_hash.to_s
end