Class: OCI::ClusterPlacementGroups::Models::ClusterPlacementGroupSummary

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

Overview

A summary object that provides the metadata details of the cluster placement group.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClusterPlacementGroupSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :name (String) —

    The value to assign to the #name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :cluster_placement_group_type (String) —

    The value to assign to the #cluster_placement_group_type property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
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
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 131

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.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.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) 


31
32
33
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 31

def availability_domain
  @availability_domain
end

#cluster_placement_group_type ⇒ String

[Required] The type of cluster placement group.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 35

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) 


27
28
29
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 27

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>>) 


65
66
67
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 65

def defined_tags
  @defined_tags
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>) 


59
60
61
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 59

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the cluster placement group.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 19

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) 


53
54
55
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 53

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the cluster placement group.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 48

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The friendly name of the cluster placement group.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 23

def name
  @name
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>>) 


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

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) 


39
40
41
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 39

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) 


44
45
46
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 44

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 74

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

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 94

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'compartment_id': :'String',
    'availability_domain': :'String',
    'cluster_placement_group_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    '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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 222

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    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 &&
    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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 263

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


243
244
245
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 243

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



252
253
254
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 252

def hash
  [id, name, compartment_id, availability_domain, cluster_placement_group_type, time_created, time_updated, lifecycle_state, lifecycle_details, 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



296
297
298
299
300
301
302
303
304
305
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 296

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



290
291
292
 
# File 'lib/oci/cluster_placement_groups/models/cluster_placement_group_summary.rb', line 290

def to_s
  to_hash.to_s
end