Class: OCI::KeyManagement::Models::KeyVersionSummary

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

Overview

The details of the KeyVersion.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ENABLING = 'ENABLING'.freeze,
  LIFECYCLE_STATE_ENABLED = 'ENABLED'.freeze,
  LIFECYCLE_STATE_DISABLING = 'DISABLING'.freeze,
  LIFECYCLE_STATE_DISABLED = 'DISABLED'.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
ORIGIN_ENUM = 
[
  ORIGIN_INTERNAL = 'INTERNAL'.freeze,
  ORIGIN_EXTERNAL = 'EXTERNAL'.freeze,
  ORIGIN_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KeyVersionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/key_management/models/key_version_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.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.id = attributes[:'id'] if attributes[:'id']

  self.key_id = attributes[:'keyId'] if attributes[:'keyId']

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

  self.key_id = attributes[:'key_id'] if attributes[:'key_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.origin = attributes[:'origin'] if attributes[:'origin']

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

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

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

  self.external_key_reference_details = attributes[:'externalKeyReferenceDetails'] if attributes[:'externalKeyReferenceDetails']

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

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

  self.is_auto_rotated = attributes[:'isAutoRotated'] unless attributes[:'isAutoRotated'].nil?

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

  self.is_auto_rotated = attributes[:'is_auto_rotated'] unless attributes[:'is_auto_rotated'].nil?
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains this key version.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#external_key_reference_details ⇒ OCI::KeyManagement::Models::ExternalKeyReferenceDetails

Returns:



73
74
75
 
# File 'lib/oci/key_management/models/key_version_summary.rb', line 73

def external_key_reference_details
  @external_key_reference_details
end

#id ⇒ String

[Required] The OCID of the key version.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/key_management/models/key_version_summary.rb', line 38

def id
  @id
end

#is_auto_rotated ⇒ BOOLEAN

An optional property indicating whether this keyversion is generated from auto rotatation.

Returns:

  • (BOOLEAN) 


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

def is_auto_rotated
  @is_auto_rotated
end

#key_id ⇒ String

[Required] The OCID of the master encryption key associated with this key version.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/key_management/models/key_version_summary.rb', line 42

def key_id
  @key_id
end

#lifecycle_state ⇒ String

The key version's current lifecycle state.

Example: ENABLED

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/key_management/models/key_version_summary.rb', line 49

def lifecycle_state
  @lifecycle_state
end

#origin ⇒ String

[Required] The source of the key material. When this value is INTERNAL, Key Management created the key material. When this value is EXTERNAL, the key material was imported from an external source.

Returns:

  • (String) 


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

def origin
  @origin
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_of_deletion ⇒ DateTime

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

Returns:

  • (DateTime) 


66
67
68
 
# File 'lib/oci/key_management/models/key_version_summary.rb', line 66

def time_of_deletion
  @time_of_deletion
end

#vault_id ⇒ String

[Required] The OCID of the vault that contains this key version.

Returns:

  • (String) 


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

def vault_id
  @vault_id
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/key_management/models/key_version_summary.rb', line 80

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'id': :'id',
    'key_id': :'keyId',
    'lifecycle_state': :'lifecycleState',
    'origin': :'origin',
    'time_created': :'timeCreated',
    'time_of_deletion': :'timeOfDeletion',
    'vault_id': :'vaultId',
    'external_key_reference_details': :'externalKeyReferenceDetails',
    'is_auto_rotated': :'isAutoRotated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/key_management/models/key_version_summary.rb', line 98

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'id': :'String',
    'key_id': :'String',
    'lifecycle_state': :'String',
    'origin': :'String',
    'time_created': :'DateTime',
    'time_of_deletion': :'DateTime',
    'vault_id': :'String',
    'external_key_reference_details': :'OCI::KeyManagement::Models::ExternalKeyReferenceDetails',
    'is_auto_rotated': :'BOOLEAN'
    # 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



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

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    id == other.id &&
    key_id == other.key_id &&
    lifecycle_state == other.lifecycle_state &&
    origin == other.origin &&
    time_created == other.time_created &&
    time_of_deletion == other.time_of_deletion &&
    vault_id == other.vault_id &&
    external_key_reference_details == other.external_key_reference_details &&
    is_auto_rotated == other.is_auto_rotated
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



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

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


242
243
244
 
# File 'lib/oci/key_management/models/key_version_summary.rb', line 242

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



251
252
253
 
# File 'lib/oci/key_management/models/key_version_summary.rb', line 251

def hash
  [compartment_id, id, key_id, lifecycle_state, origin, time_created, time_of_deletion, vault_id, external_key_reference_details, is_auto_rotated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



295
296
297
298
299
300
301
302
303
304
 
# File 'lib/oci/key_management/models/key_version_summary.rb', line 295

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



289
290
291
 
# File 'lib/oci/key_management/models/key_version_summary.rb', line 289

def to_s
  to_hash.to_s
end