Class: OCI::CapacityManagement::Models::CreateOccCustomerGroupDetails

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

Overview

Details about the create request for the customer group.

Constant Summary collapse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOccCustomerGroupDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
143
144
145
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 99

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

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

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_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.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

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

  self.customers_list = attributes[:'customersList'] if attributes[:'customersList']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 19

def compartment_id
  @compartment_id
end

#customers_list ⇒ Array<OCI::CapacityManagement::Models::CreateOccCustomerDetails>

A list containing all the customers that belong to this customer group.

Returns:



51
52
53
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 51

def customers_list
  @customers_list
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


39
40
41
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 39

def defined_tags
  @defined_tags
end

#description ⇒ String

A description about the customer group.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 27

def description
  @description
end

#display_name ⇒ String

[Required] The name of the customer group.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 23

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


33
34
35
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 33

def freeform_tags
  @freeform_tags
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 43

def lifecycle_details
  @lifecycle_details
end

#status ⇒ String

To determine whether the customer group is enabled/disabled.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 47

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'lifecycle_details': :'lifecycleDetails',
    'status': :'status',
    'customers_list': :'customersList'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_details': :'String',
    'status': :'String',
    'customers_list': :'Array<OCI::CapacityManagement::Models::CreateOccCustomerDetails>'
    # 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



162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 162

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    lifecycle_details == other.lifecycle_details &&
    status == other.status &&
    customers_list == other.customers_list
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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 199

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


179
180
181
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 179

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



188
189
190
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 188

def hash
  [compartment_id, display_name, description, freeform_tags, defined_tags, lifecycle_details, status, customers_list].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 232

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



226
227
228
 
# File 'lib/oci/capacity_management/models/create_occ_customer_group_details.rb', line 226

def to_s
  to_hash.to_s
end