Class: OCI::ClusterPlacementGroups::Models::ClusterPlacementGroup

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cluster_placement_groups/models/cluster_placement_group.rb

Overview

A cluster placement group, which is a logical grouping of resources that offer low latency within an availability domain by being placed in close physical proximity.

Constant Summary collapse

CLUSTER_PLACEMENT_GROUP_TYPE_ENUM = 
[
  CLUSTER_PLACEMENT_GROUP_TYPE_STANDARD = 'STANDARD'.freeze,
  CLUSTER_PLACEMENT_GROUP_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClusterPlacementGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 164

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

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

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

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

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

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

  self.cluster_placement_group_type = attributes[:'clusterPlacementGroupType'] if attributes[:'clusterPlacementGroupType']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#availability_domain ⇒ String

[Required] The availability domain of the cluster placement group.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 50

def availability_domain
  @availability_domain
end

#capabilities ⇒ OCI::ClusterPlacementGroups::Models::CapabilitiesCollection

Returns:



77
78
79
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 77

def capabilities
  @capabilities
end

#cluster_placement_group_type ⇒ String

[Required] The type of cluster placement group.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 54

def cluster_placement_group_type
  @cluster_placement_group_type
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the cluster placement group.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 46

def compartment_id
  @compartment_id
end

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

[Required] 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>>) 


89
90
91
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 89

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] A description of the cluster placement group.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 41

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

[Required] 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>) 


83
84
85
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 83

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the cluster placement group.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 32

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, lifecycle details for a resource in a Failed state might include information to act on.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 71

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the ClusterPlacementGroup.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 66

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The user-friendly name of the cluster placement group. The display name for a cluster placement must be unique and you cannot change it. Avoid entering confidential information.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 37

def name
  @name
end

#placement_instruction ⇒ OCI::ClusterPlacementGroups::Models::PlacementInstructionDetails

Returns:



74
75
76
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 74

def placement_instruction
  @placement_instruction
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


95
96
97
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 95

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the cluster placement group was created, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 58

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the cluster placement group was updated, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 62

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 98

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'availability_domain': :'availabilityDomain',
    'cluster_placement_group_type': :'clusterPlacementGroupType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'placement_instruction': :'placementInstruction',
    'capabilities': :'capabilities',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 121

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'availability_domain': :'String',
    'cluster_placement_group_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'placement_instruction': :'OCI::ClusterPlacementGroups::Models::PlacementInstructionDetails',
    'capabilities': :'OCI::ClusterPlacementGroups::Models::CapabilitiesCollection',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 278

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    availability_domain == other.availability_domain &&
    cluster_placement_group_type == other.cluster_placement_group_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    placement_instruction == other.placement_instruction &&
    capabilities == other.capabilities &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 322

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


302
303
304
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 302

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



311
312
313
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 311

def hash
  [id, name, description, compartment_id, availability_domain, cluster_placement_group_type, time_created, time_updated, lifecycle_state, lifecycle_details, placement_instruction, capabilities, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



355
356
357
358
359
360
361
362
363
364
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 355

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



349
350
351
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group.rb', line 349

def to_s
  to_hash.to_s
end