Class: OCI::KeyManagement::Models::HsmPartitionSummary

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

Overview

An object which encapsulates the details of a given HSM.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HsmPartitionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



91
92
93
94
95
96
97
98
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
 
# File 'lib/oci/key_management/models/hsm_partition_summary.rb', line 91

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

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

  self.hsm_cluster_id = attributes[:'hsm_cluster_id'] if attributes[:'hsm_cluster_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.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.port_information = attributes[:'portInformation'] if attributes[:'portInformation']

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/key_management/models/hsm_partition_summary.rb', line 28

def compartment_id
  @compartment_id
end

#hsm_cluster_id ⇒ String

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

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/key_management/models/hsm_partition_summary.rb', line 17

def hsm_cluster_id
  @hsm_cluster_id
end

#id ⇒ String

[Required] The OCID of the HSM resource. Each HSM resource will have a unique OCID identifier.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

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

Example: ACTIVE

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/key_management/models/hsm_partition_summary.rb', line 24

def lifecycle_state
  @lifecycle_state
end

#port_information ⇒ Array<OCI::KeyManagement::Models::PortInformation>

[Required] Details of a single portInformation item include the PortNumber (an integer used as an identifier) and the PortType (refers to either an enum value of Managementutility,Clientutility, or null)

Returns:



32
33
34
 
# File 'lib/oci/key_management/models/hsm_partition_summary.rb', line 32

def port_information
  @port_information
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/key_management/models/hsm_partition_summary.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'hsm_cluster_id': :'hsmClusterId',
    'lifecycle_state': :'lifecycleState',
    'compartment_id': :'compartmentId',
    'port_information': :'portInformation',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/key_management/models/hsm_partition_summary.rb', line 64

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'hsm_cluster_id': :'String',
    'lifecycle_state': :'String',
    'compartment_id': :'String',
    'port_information': :'Array<OCI::KeyManagement::Models::PortInformation>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime'
    # 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



143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/key_management/models/hsm_partition_summary.rb', line 143

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

  self.class == other.class &&
    id == other.id &&
    hsm_cluster_id == other.hsm_cluster_id &&
    lifecycle_state == other.lifecycle_state &&
    compartment_id == other.compartment_id &&
    port_information == other.port_information &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/key_management/models/hsm_partition_summary.rb', line 179

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


159
160
161
 
# File 'lib/oci/key_management/models/hsm_partition_summary.rb', line 159

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



168
169
170
 
# File 'lib/oci/key_management/models/hsm_partition_summary.rb', line 168

def hash
  [id, hsm_cluster_id, lifecycle_state, compartment_id, port_information, time_created, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/key_management/models/hsm_partition_summary.rb', line 212

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



206
207
208
 
# File 'lib/oci/key_management/models/hsm_partition_summary.rb', line 206

def to_s
  to_hash.to_s
end