Class: OCI::Vault::Models::SecretVersionSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vault/models/secret_version_summary.rb

Overview

The secret version summary object, which doesn't include the contents of the secret.

Constant Summary collapse

CONTENT_TYPE_ENUM =
[
  CONTENT_TYPE_BASE64 = 'BASE64'.freeze,
  CONTENT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STAGES_ENUM =
[
  STAGES_CURRENT = 'CURRENT'.freeze,
  STAGES_PENDING = 'PENDING'.freeze,
  STAGES_LATEST = 'LATEST'.freeze,
  STAGES_PREVIOUS = 'PREVIOUS'.freeze,
  STAGES_DEPRECATED = 'DEPRECATED'.freeze,
  STAGES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecretVersionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :content_type (String)

    The value to assign to the #content_type property

  • :name (String)

    The value to assign to the #name property

  • :secret_id (String)

    The value to assign to the #secret_id property

  • :stages (Array<String>)

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

  • :time_of_expiry (DateTime)

    The value to assign to the #time_of_expiry property

  • :version_number (Integer)

    The value to assign to the #version_number 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/vault/models/secret_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.content_type = attributes[:'contentType'] if attributes[:'contentType']

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

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

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

  self.secret_id = attributes[:'secretId'] if attributes[:'secretId']

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

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

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

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

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

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

  self.version_number = attributes[:'versionNumber'] if attributes[:'versionNumber']

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

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

Instance Attribute Details

#content_typeString

The content type of the secret version's secret contents.

Returns:

  • (String)


28
29
30
# File 'lib/oci/vault/models/secret_version_summary.rb', line 28

def content_type
  @content_type
end

#nameString

The name of the secret version. A name is unique across versions of a secret.

Returns:

  • (String)


33
34
35
# File 'lib/oci/vault/models/secret_version_summary.rb', line 33

def name
  @name
end

#secret_idString

[Required] The OCID of the secret.

Returns:

  • (String)


37
38
39
# File 'lib/oci/vault/models/secret_version_summary.rb', line 37

def secret_id
  @secret_id
end

#stagesArray<String>

A list of possible rotation states for the secret version. A secret version marked CURRENT is currently in use. A secret version marked PENDING is staged and available for use, but has not been applied on the target system and, therefore, has not been rotated into current, active use. The secret most recently uploaded to a vault is always marked LATEST. (The first version of a secret is always marked as both CURRENT and LATEST.) A secret version marked PREVIOUS is the secret version that was most recently marked CURRENT, before the last secret version rotation. A secret version marked DEPRECATED is neither current, pending, nor the previous one in use. Only secret versions marked DEPRECATED can be scheduled for deletion.

Returns:

  • (Array<String>)


47
48
49
# File 'lib/oci/vault/models/secret_version_summary.rb', line 47

def stages
  @stages
end

#time_createdDateTime

[Required] A optional property indicating when the secret version was created, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns:

  • (DateTime)


53
54
55
# File 'lib/oci/vault/models/secret_version_summary.rb', line 53

def time_created
  @time_created
end

#time_of_deletionDateTime

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

Returns:

  • (DateTime)


59
60
61
# File 'lib/oci/vault/models/secret_version_summary.rb', line 59

def time_of_deletion
  @time_of_deletion
end

#time_of_expiryDateTime

An optional property indicating when the secret version will expire, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns:

  • (DateTime)


65
66
67
# File 'lib/oci/vault/models/secret_version_summary.rb', line 65

def time_of_expiry
  @time_of_expiry
end

#version_numberInteger

[Required] The version number of the secret.

Returns:

  • (Integer)


69
70
71
# File 'lib/oci/vault/models/secret_version_summary.rb', line 69

def version_number
  @version_number
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/vault/models/secret_version_summary.rb', line 72

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'content_type': :'contentType',
    'name': :'name',
    'secret_id': :'secretId',
    'stages': :'stages',
    'time_created': :'timeCreated',
    'time_of_deletion': :'timeOfDeletion',
    'time_of_expiry': :'timeOfExpiry',
    'version_number': :'versionNumber'
    # 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/vault/models/secret_version_summary.rb', line 88

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'content_type': :'String',
    'name': :'String',
    'secret_id': :'String',
    'stages': :'Array<String>',
    'time_created': :'DateTime',
    'time_of_deletion': :'DateTime',
    'time_of_expiry': :'DateTime',
    'version_number': :'Integer'
    # 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



204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/oci/vault/models/secret_version_summary.rb', line 204

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

  self.class == other.class &&
    content_type == other.content_type &&
    name == other.name &&
    secret_id == other.secret_id &&
    stages == other.stages &&
    time_created == other.time_created &&
    time_of_deletion == other.time_of_deletion &&
    time_of_expiry == other.time_of_expiry &&
    version_number == other.version_number
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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'lib/oci/vault/models/secret_version_summary.rb', line 241

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


221
222
223
# File 'lib/oci/vault/models/secret_version_summary.rb', line 221

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



230
231
232
# File 'lib/oci/vault/models/secret_version_summary.rb', line 230

def hash
  [content_type, name, secret_id, stages, time_created, time_of_deletion, time_of_expiry, version_number].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



274
275
276
277
278
279
280
281
282
283
# File 'lib/oci/vault/models/secret_version_summary.rb', line 274

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



268
269
270
# File 'lib/oci/vault/models/secret_version_summary.rb', line 268

def to_s
  to_hash.to_s
end