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

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

Overview

KeyVersionSummary model.

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

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :id (String)

    The value to assign to the #id property

  • :key_id (String)

    The value to assign to the #key_id property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :origin (String)

    The value to assign to the #origin property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :time_of_deletion (DateTime)

    The value to assign to the #time_of_deletion property

  • :vault_id (String)

    The value to assign to the #vault_id property



117
118
119
120
121
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
# File 'lib/oci/key_management/models/key_version_summary.rb', line 117

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

Instance Attribute Details

#compartment_idString

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

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

#idString

[Required] The OCID of the key version.

Returns:

  • (String)


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

def id
  @id
end

#key_idString

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

Returns:

  • (String)


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

def key_id
  @key_id
end

#lifecycle_stateString

The key version's current lifecycle state.

Example: ENABLED

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#originString

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


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

def origin
  @origin
end

#time_createdDateTime

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


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

def time_created
  @time_created
end

#time_of_deletionDateTime

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)


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

def time_of_deletion
  @time_of_deletion
end

#vault_idString

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

Returns:

  • (String)


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

def vault_id
  @vault_id
end

Class Method Details

.attribute_mapObject

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



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

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

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'
    # 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



197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/oci/key_management/models/key_version_summary.rb', line 197

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



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

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


214
215
216
# File 'lib/oci/key_management/models/key_version_summary.rb', line 214

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



223
224
225
# File 'lib/oci/key_management/models/key_version_summary.rb', line 223

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



267
268
269
270
271
272
273
274
275
276
# File 'lib/oci/key_management/models/key_version_summary.rb', line 267

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



261
262
263
# File 'lib/oci/key_management/models/key_version_summary.rb', line 261

def to_s
  to_hash.to_s
end