Class: OCI::KeyManagement::Models::HsmCluster

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

Overview

Dedicated KMS-HSM Cluster Management

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_INITIALIZATION_REQUIRED = 'INITIALIZATION_REQUIRED'.freeze,
  LIFECYCLE_STATE_INITIALIZING = 'INITIALIZING'.freeze,
  LIFECYCLE_STATE_ACTIVATION_REQUIRED = 'ACTIVATION_REQUIRED'.freeze,
  LIFECYCLE_STATE_ACTIVATING = 'ACTIVATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_PENDING_DELETION = 'PENDING_DELETION'.freeze,
  LIFECYCLE_STATE_SCHEDULING_DELETION = 'SCHEDULING_DELETION'.freeze,
  LIFECYCLE_STATE_CANCELLING_DELETION = 'CANCELLING_DELETION'.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 = {}) ⇒ HsmCluster

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 150

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

  self.audit_log_config = attributes[:'auditLogConfig'] if attributes[:'auditLogConfig']

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

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

  self.pending_instructions = attributes[:'pendingInstructions'] if attributes[:'pendingInstructions']

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

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

Instance Attribute Details

#audit_log_config ⇒ OCI::KeyManagement::Models::HsmClusterAuditLoggingInfo

Returns:



87
88
89
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 87

def audit_log_config
  @audit_log_config
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 33

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


77
78
79
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 77

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 39

def display_name
  @display_name
end

#dns_name ⇒ String

[Required] DNS name for the HSM Cluster – this will contain information about the region as well.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 64

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


84
85
86
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 84

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the HSMCluster resource.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 29

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The HSMCluster's current state.

Example: ACTIVE

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 60

def lifecycle_state
  @lifecycle_state
end

#pending_instructions ⇒ OCI::KeyManagement::Models::HsmClusterPendingInstructions

Returns:



90
91
92
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 90

def pending_instructions
  @pending_instructions
end

#time_created ⇒ DateTime

[Required] The date and time this HSM resource was created, expressed in RFC 3339 timestamp format.

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

Returns:

  • (DateTime) 


46
47
48
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 46

def time_created
  @time_created
end

#time_of_deletion ⇒ DateTime

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

Returns:

  • (DateTime) 


70
71
72
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 70

def time_of_deletion
  @time_of_deletion
end

#time_updated ⇒ DateTime

[Required] The date and time this HSM resource was updated, expressed in RFC 3339 timestamp format.

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

Returns:

  • (DateTime) 


53
54
55
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 53

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 113

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 245

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

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 286

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


266
267
268
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 266

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



275
276
277
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 275

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



319
320
321
322
323
324
325
326
327
328
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 319

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



313
314
315
 
# File 'lib/oci/key_management/models/hsm_cluster.rb', line 313

def to_s
  to_hash.to_s
end