Class: OCI::KeyManagement::Models::HsmClusterSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/key_management/models/hsm_cluster_summary.rb

Overview

The details of the HSM resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HsmClusterSummary

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :dns_name (String) —

    The value to assign to the #dns_name 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

  • :time_of_deletion (DateTime) —

    The value to assign to the #time_of_deletion property

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

    The value to assign to the #defined_tags property

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

    The value to assign to the #freeform_tags property



122
123
124
125
126
127
128
129
130
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
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 122

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

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

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

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

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

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

  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.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']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains a particular HSMCluster resource.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 23

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


61
62
63
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 61

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name for a HSMCluster resource. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 19

def display_name
  @display_name
end

#dns_name ⇒ String

[Required] DNS name for the HSMCluster.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 34

def dns_name
  @dns_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


68
69
70
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 68

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of a HSMCluster resource.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 13

def id
  @id
end

#lifecycle_state ⇒ String

[Required] A HSMCluster resource's current lifecycle state.

Example: ACTIVE

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 30

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

[Required] The date and time a dedicated KMS resource was created, expressed in RFC 3339 timestamp format.

Example: 2023-04-03T21:10:29.600Z

Returns:

  • (DateTime) 


41
42
43
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 41

def time_created
  @time_created
end

#time_of_deletion ⇒ DateTime

An optional property indicating when to delete the resource, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns:

  • (DateTime) 


54
55
56
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 54

def time_of_deletion
  @time_of_deletion
end

#time_updated ⇒ DateTime

[Required] The date and time a dedicated KMS resource was updated, expressed in RFC 3339 timestamp format.

Example: 2023-04-03T21:10:29.600Z

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 48

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'dns_name': :'dnsName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_of_deletion': :'timeOfDeletion',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 89

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'dns_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_of_deletion': :'DateTime',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, 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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 192

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    dns_name == other.dns_name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_of_deletion == other.time_of_deletion &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 231

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


211
212
213
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 211

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 220

def hash
  [id, display_name, compartment_id, lifecycle_state, dns_name, time_created, time_updated, time_of_deletion, defined_tags, freeform_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



264
265
266
267
268
269
270
271
272
273
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 264

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



258
259
260
 
# File 'lib/oci/key_management/models/hsm_cluster_summary.rb', line 258

def to_s
  to_hash.to_s
end