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
ROTATION_STATUS_ENUM = 
[
  ROTATION_STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  ROTATION_STATUS_SCHEDULED = 'SCHEDULED'.freeze,
  ROTATION_STATUS_NOT_ENABLED = 'NOT_ENABLED'.freeze,
  ROTATION_STATUS_CANCELLING = 'CANCELLING'.freeze,
  ROTATION_STATUS_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):



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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oci/vault/models/secret.rb', line 228

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

  self.rotation_config = attributes[:'rotationConfig'] if attributes[:'rotationConfig']

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

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

  self.rotation_status = attributes[:'rotationStatus'] if attributes[:'rotationStatus']

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

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

  self.last_rotation_time = attributes[:'lastRotationTime'] if attributes[:'lastRotationTime']

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

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

  self.next_rotation_time = attributes[:'nextRotationTime'] if attributes[:'nextRotationTime']

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

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

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

  self.secret_generation_context = attributes[:'secretGenerationContext'] if attributes[:'secretGenerationContext']

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

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

  self.is_auto_generation_enabled = attributes[:'isAutoGenerationEnabled'] unless attributes[:'isAutoGenerationEnabled'].nil?

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment where you want to create the secret.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/vault/models/secret.rb', line 35

def compartment_id
  @compartment_id
end

#current_version_number ⇒ Integer

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

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/oci/vault/models/secret.rb', line 39

def current_version_number
  @current_version_number
end

#defined_tags ⇒ Hash<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>>) 


46
47
48
 
# File 'lib/oci/vault/models/secret.rb', line 46

def defined_tags
  @defined_tags
end

#description ⇒ String

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

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/vault/models/secret.rb', line 50

def description
  @description
end

#freeform_tags ⇒ Hash<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>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the secret.

Returns:

  • (String) 


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

def id
  @id
end

#is_auto_generation_enabled ⇒ BOOLEAN

The value of this flag determines whether or not secret content will be generated automatically.

Returns:

  • (BOOLEAN) 


138
139
140
 
# File 'lib/oci/vault/models/secret.rb', line 138

def is_auto_generation_enabled
  @is_auto_generation_enabled
end

#key_id ⇒ String

The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/vault/models/secret.rb', line 66

def key_id
  @key_id
end

#last_rotation_time ⇒ DateTime

A property indicating when the secret was last rotated successfully, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns:

  • (DateTime) 


94
95
96
 
# File 'lib/oci/vault/models/secret.rb', line 94

def last_rotation_time
  @last_rotation_time
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state of the secret.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the secret.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#metadata ⇒ Hash<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>) 


81
82
83
 
# File 'lib/oci/vault/models/secret.rb', line 81

def metadata
  @metadata
end

#next_rotation_time ⇒ DateTime

A property indicating when the secret is scheduled to be rotated, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns:

  • (DateTime) 


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

def next_rotation_time
  @next_rotation_time
end

#rotation_config ⇒ OCI::Vault::Models::RotationConfig

Returns:



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

def rotation_config
  @rotation_config
end

#rotation_status ⇒ String

Additional information about the status of the secret rotation

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/vault/models/secret.rb', line 88

def rotation_status
  @rotation_status
end

#secret_generation_context ⇒ OCI::Vault::Models::SecretGenerationContext

Returns:



133
134
135
 
# File 'lib/oci/vault/models/secret.rb', line 133

def secret_generation_context
  @secret_generation_context
end

#secret_name ⇒ String

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

Returns:

  • (String) 


104
105
106
 
# File 'lib/oci/vault/models/secret.rb', line 104

def secret_name
  @secret_name
end

#secret_rules ⇒ Array<OCI::Vault::Models::SecretRule>

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

Returns:



108
109
110
 
# File 'lib/oci/vault/models/secret.rb', line 108

def secret_rules
  @secret_rules
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


114
115
116
 
# File 'lib/oci/vault/models/secret.rb', line 114

def time_created
  @time_created
end

#time_of_current_version_expiry ⇒ DateTime

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) 


120
121
122
 
# File 'lib/oci/vault/models/secret.rb', line 120

def time_of_current_version_expiry
  @time_of_current_version_expiry
end

#time_of_deletion ⇒ DateTime

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

Returns:

  • (DateTime) 


126
127
128
 
# File 'lib/oci/vault/models/secret.rb', line 126

def time_of_deletion
  @time_of_deletion
end

#vault_id ⇒ String

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

Returns:

  • (String) 


130
131
132
 
# File 'lib/oci/vault/models/secret.rb', line 130

def vault_id
  @vault_id
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/vault/models/secret.rb', line 141

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',
    'rotation_config': :'rotationConfig',
    'rotation_status': :'rotationStatus',
    'last_rotation_time': :'lastRotationTime',
    'next_rotation_time': :'nextRotationTime',
    'secret_name': :'secretName',
    'secret_rules': :'secretRules',
    'time_created': :'timeCreated',
    'time_of_current_version_expiry': :'timeOfCurrentVersionExpiry',
    'time_of_deletion': :'timeOfDeletion',
    'vault_id': :'vaultId',
    'secret_generation_context': :'secretGenerationContext',
    'is_auto_generation_enabled': :'isAutoGenerationEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



171
172
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
 
# File 'lib/oci/vault/models/secret.rb', line 171

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>',
    'rotation_config': :'OCI::Vault::Models::RotationConfig',
    'rotation_status': :'String',
    'last_rotation_time': :'DateTime',
    'next_rotation_time': :'DateTime',
    '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',
    'secret_generation_context': :'OCI::Vault::Models::SecretGenerationContext',
    'is_auto_generation_enabled': :'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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/oci/vault/models/secret.rb', line 388

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 &&
    metadata == other.metadata &&
    rotation_config == other.rotation_config &&
    rotation_status == other.rotation_status &&
    last_rotation_time == other.last_rotation_time &&
    next_rotation_time == other.next_rotation_time &&
    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 &&
    secret_generation_context == other.secret_generation_context &&
    is_auto_generation_enabled == other.is_auto_generation_enabled
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



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/oci/vault/models/secret.rb', line 439

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


419
420
421
 
# File 'lib/oci/vault/models/secret.rb', line 419

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



428
429
430
 
# File 'lib/oci/vault/models/secret.rb', line 428

def hash
  [compartment_id, current_version_number, defined_tags, description, freeform_tags, id, key_id, lifecycle_details, lifecycle_state, metadata, rotation_config, rotation_status, last_rotation_time, next_rotation_time, secret_name, secret_rules, time_created, time_of_current_version_expiry, time_of_deletion, vault_id, secret_generation_context, is_auto_generation_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



472
473
474
475
476
477
478
479
480
481
 
# File 'lib/oci/vault/models/secret.rb', line 472

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



466
467
468
 
# File 'lib/oci/vault/models/secret.rb', line 466

def to_s
  to_hash.to_s
end