Class: OCI::Secrets::Models::SecretBundleVersionSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/secrets/models/secret_bundle_version_summary.rb

Overview

The properties of the secret bundle. (Secret bundle version summary objects do not include the actual contents of the secret.)

Constant Summary collapse

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 = {}) ⇒ SecretBundleVersionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :secret_id (String)

    The value to assign to the #secret_id property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :version_number (Integer)

    The value to assign to the #version_number property

  • :version_name (String)

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

  • :stages (Array<String>)

    The value to assign to the #stages property



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
135
136
137
138
139
140
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 97

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

  self.version_name = attributes[:'versionName'] if attributes[:'versionName']

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

  self.version_name = attributes[:'version_name'] if attributes[:'version_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.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.stages = attributes[:'stages'] if attributes[:'stages']
end

Instance Attribute Details

#secret_idString

[Required] The OCID of the secret.

Returns:

  • (String)


23
24
25
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 23

def secret_id
  @secret_id
end

#stagesArray<String>

A list of possible rotation states for the secret bundle.

Returns:

  • (Array<String>)


52
53
54
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 52

def stages
  @stages
end

#time_createdDateTime

The time when the secret bundle was created.

Returns:

  • (DateTime)


27
28
29
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 27

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)


42
43
44
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 42

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)


48
49
50
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 48

def time_of_expiry
  @time_of_expiry
end

#version_nameString

The version name of the secret bundle, as provided when the secret was created or last rotated.

Returns:

  • (String)


36
37
38
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 36

def version_name
  @version_name
end

#version_numberInteger

[Required] The version number of the secret.

Returns:

  • (Integer)


31
32
33
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 31

def version_number
  @version_number
end

Class Method Details

.attribute_mapObject

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



55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'secret_id': :'secretId',
    'time_created': :'timeCreated',
    'version_number': :'versionNumber',
    'version_name': :'versionName',
    'time_of_deletion': :'timeOfDeletion',
    'time_of_expiry': :'timeOfExpiry',
    'stages': :'stages'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 70

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



169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 169

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

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 205

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


185
186
187
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 185

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



194
195
196
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 194

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



238
239
240
241
242
243
244
245
246
247
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 238

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



232
233
234
# File 'lib/oci/secrets/models/secret_bundle_version_summary.rb', line 232

def to_s
  to_hash.to_s
end