Class: OCI::Vault::Models::SecretSummary

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

Overview

The details of the secret, excluding the contents of the secret.

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

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

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

  • :key_id (String) —

    The value to assign to the #key_id property

  • :id (String) —

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

  • :secret_name (String) —

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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
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
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
 
# File 'lib/oci/vault/models/secret_summary.rb', line 149

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.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.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.id = attributes[:'id'] if attributes[:'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.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.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_id ⇒ String

[Required] The OCID of the compartment that contains the secret.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: ‘{"CostCenter": "42"}`

Returns:

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

A brief description of the secret.

Returns:

  • (String) 


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

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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


44
45
46
 
# File 'lib/oci/vault/models/secret_summary.rb', line 44

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the secret.

Returns:

  • (String) 


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

def id
  @id
end

#key_id ⇒ String

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

Returns:

  • (String) 


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

def key_id
  @key_id
end

#lifecycle_details ⇒ String

Additional information about the secret’s current lifecycle state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the secret.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#secret_name ⇒ String

[Required] The name of the secret.

Returns:

  • (String) 


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

def secret_name
  @secret_name
end

#time_created ⇒ DateTime

[Required] A property indicating when the secret was created, expressed in [RFC 3339](tools.ietf.org/html/rfc3339) timestamp format. Example: ‘2019-04-03T21:10:29.600Z`

Returns:

  • (DateTime) 


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

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](tools.ietf.org/html/rfc3339) timestamp format. Example: ‘2019-04-03T21:10:29.600Z`

Returns:

  • (DateTime) 


76
77
78
 
# File 'lib/oci/vault/models/secret_summary.rb', line 76

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](tools.ietf.org/html/rfc3339) timestamp format. Example: ‘2019-04-03T21:10:29.600Z`

Returns:

  • (DateTime) 


82
83
84
 
# File 'lib/oci/vault/models/secret_summary.rb', line 82

def time_of_deletion
  @time_of_deletion
end

#vault_id ⇒ String

[Required] The OCID of the Vault in which the secret exists

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/vault/models/secret_summary.rb', line 86

def vault_id
  @vault_id
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/vault/models/secret_summary.rb', line 89

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

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/vault/models/secret_summary.rb', line 110

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'key_id': :'String',
    'id': :'String',
    'lifecycle_details': :'String',
    'lifecycle_state': :'String',
    'secret_name': :'String',
    '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



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

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

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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/oci/vault/models/secret_summary.rb', line 288

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



277
278
279
 
# File 'lib/oci/vault/models/secret_summary.rb', line 277

def hash
  [compartment_id, defined_tags, description, freeform_tags, key_id, id, lifecycle_details, lifecycle_state, secret_name, time_created, time_of_current_version_expiry, time_of_deletion, vault_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



321
322
323
324
325
326
327
328
329
330
 
# File 'lib/oci/vault/models/secret_summary.rb', line 321

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



315
316
317
 
# File 'lib/oci/vault/models/secret_summary.rb', line 315

def to_s
  to_hash.to_s
end