Class: OCI::Vault::Models::Secret

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

Overview

The details of the secret. Secret details do not contain the contents of the secret itself.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_SCHEDULING_DELETION = 'SCHEDULING_DELETION'.freeze,
  LIFECYCLE_STATE_PENDING_DELETION = 'PENDING_DELETION'.freeze,
  LIFECYCLE_STATE_CANCELLING_DELETION = 'CANCELLING_DELETION'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Secret

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

  • :current_version_number (Integer)

    The value to assign to the #current_version_number property

  • :defined_tags (Hash<String, Hash<String, Object>>)

    The value to assign to the #defined_tags property

  • :description (String)

    The value to assign to the #description property

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags property

  • :id (String)

    The value to assign to the #id property

  • :key_id (String)

    The value to assign to the #key_id property

  • :lifecycle_details (String)

    The value to assign to the #lifecycle_details property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :metadata (Hash<String, Object>)

    The value to assign to the #metadata property

  • :secret_name (String)

    The value to assign to the #secret_name property

  • :secret_rules (Array<OCI::Vault::Models::SecretRule>)

    The value to assign to the #secret_rules property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :time_of_current_version_expiry (DateTime)

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/oci/vault/models/secret.rb', line 173

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

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  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_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

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

  self.secret_name = attributes[:'secretName'] if attributes[:'secretName']

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

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

  self.secret_rules = attributes[:'secretRules'] if attributes[:'secretRules']

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

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

  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_current_version_expiry = attributes[:'timeOfCurrentVersionExpiry'] if attributes[:'timeOfCurrentVersionExpiry']

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

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

  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 where you want to create the secret.

Returns:

  • (String)


26
27
28
# File 'lib/oci/vault/models/secret.rb', line 26

def compartment_id
  @compartment_id
end

#current_version_numberInteger

The version number of the secret version that's currently in use.

Returns:

  • (Integer)


30
31
32
# File 'lib/oci/vault/models/secret.rb', line 30

def current_version_number
  @current_version_number
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>)


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

def defined_tags
  @defined_tags
end

#descriptionString

A brief description of the secret. Avoid entering confidential information.

Returns:

  • (String)


41
42
43
# File 'lib/oci/vault/models/secret.rb', line 41

def description
  @description
end

#freeform_tagsHash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


48
49
50
# File 'lib/oci/vault/models/secret.rb', line 48

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the secret.

Returns:

  • (String)


52
53
54
# File 'lib/oci/vault/models/secret.rb', line 52

def id
  @id
end

#key_idString

The OCID of the master encryption key that is used to encrypt the secret.

Returns:

  • (String)


56
57
58
# File 'lib/oci/vault/models/secret.rb', line 56

def key_id
  @key_id
end

#lifecycle_detailsString

Additional information about the current lifecycle state of the secret.

Returns:

  • (String)


60
61
62
# File 'lib/oci/vault/models/secret.rb', line 60

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

[Required] The current lifecycle state of the secret.

Returns:

  • (String)


64
65
66
# File 'lib/oci/vault/models/secret.rb', line 64

def lifecycle_state
  @lifecycle_state
end

#metadataHash<String, Object>

Additional metadata that you can use to provide context about how to use the secret or during rotation or other administrative tasks. For example, for a secret that you use to connect to a database, the additional metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.

Returns:

  • (Hash<String, Object>)


71
72
73
# File 'lib/oci/vault/models/secret.rb', line 71

def 
  @metadata
end

#secret_nameString

[Required] The user-friendly name of the secret. Avoid entering confidential information.

Returns:

  • (String)


75
76
77
# File 'lib/oci/vault/models/secret.rb', line 75

def secret_name
  @secret_name
end

#secret_rulesArray<OCI::Vault::Models::SecretRule>

A list of rules that control how the secret is used and managed.

Returns:



79
80
81
# File 'lib/oci/vault/models/secret.rb', line 79

def secret_rules
  @secret_rules
end

#time_createdDateTime

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

Returns:

  • (DateTime)


85
86
87
# File 'lib/oci/vault/models/secret.rb', line 85

def time_created
  @time_created
end

#time_of_current_version_expiryDateTime

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

Returns:

  • (DateTime)


91
92
93
# File 'lib/oci/vault/models/secret.rb', line 91

def time_of_current_version_expiry
  @time_of_current_version_expiry
end

#time_of_deletionDateTime

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

Returns:

  • (DateTime)


97
98
99
# File 'lib/oci/vault/models/secret.rb', line 97

def time_of_deletion
  @time_of_deletion
end

#vault_idString

[Required] The OCID of the vault where the secret exists.

Returns:

  • (String)


101
102
103
# File 'lib/oci/vault/models/secret.rb', line 101

def vault_id
  @vault_id
end

Class Method Details

.attribute_mapObject

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'lib/oci/vault/models/secret.rb', line 104

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'current_version_number': :'currentVersionNumber',
    'defined_tags': :'definedTags',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'key_id': :'keyId',
    'lifecycle_details': :'lifecycleDetails',
    'lifecycle_state': :'lifecycleState',
    'metadata': :'metadata',
    'secret_name': :'secretName',
    'secret_rules': :'secretRules',
    'time_created': :'timeCreated',
    'time_of_current_version_expiry': :'timeOfCurrentVersionExpiry',
    'time_of_deletion': :'timeOfDeletion',
    'vault_id': :'vaultId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/oci/vault/models/secret.rb', line 128

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'current_version_number': :'Integer',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'key_id': :'String',
    'lifecycle_details': :'String',
    'lifecycle_state': :'String',
    'metadata': :'Hash<String, Object>',
    'secret_name': :'String',
    'secret_rules': :'Array<OCI::Vault::Models::SecretRule>',
    'time_created': :'DateTime',
    'time_of_current_version_expiry': :'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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/oci/vault/models/secret.rb', line 284

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    current_version_number == other.current_version_number &&
    defined_tags == other.defined_tags &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    key_id == other.key_id &&
    lifecycle_details == other.lifecycle_details &&
    lifecycle_state == other.lifecycle_state &&
     == other. &&
    secret_name == other.secret_name &&
    secret_rules == other.secret_rules &&
    time_created == other.time_created &&
    time_of_current_version_expiry == other.time_of_current_version_expiry &&
    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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'lib/oci/vault/models/secret.rb', line 329

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


309
310
311
# File 'lib/oci/vault/models/secret.rb', line 309

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



318
319
320
# File 'lib/oci/vault/models/secret.rb', line 318

def hash
  [compartment_id, current_version_number, defined_tags, description, freeform_tags, id, key_id, lifecycle_details, lifecycle_state, , secret_name, secret_rules, time_created, time_of_current_version_expiry, 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



362
363
364
365
366
367
368
369
370
371
# File 'lib/oci/vault/models/secret.rb', line 362

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



356
357
358
# File 'lib/oci/vault/models/secret.rb', line 356

def to_s
  to_hash.to_s
end