Class: OCI::Vault::Models::Secret
- Inherits:
-
Object
- Object
- OCI::Vault::Models::Secret
- 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
-
#compartment_id ⇒ String
[Required] The OCID of the compartment where you want to create the secret.
-
#current_version_number ⇒ Integer
The version number of the secret version that's currently in use.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
A brief description of the secret.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the secret.
-
#key_id ⇒ String
The OCID of the master encryption key that is used to encrypt the secret.
-
#lifecycle_details ⇒ String
Additional information about the current lifecycle state of the secret.
-
#lifecycle_state ⇒ String
[Required] The current lifecycle state of the secret.
-
#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.
-
#secret_name ⇒ String
[Required] The user-friendly name of the secret.
-
#secret_rules ⇒ Array<OCI::Vault::Models::SecretRule>
A list of rules that control how the secret is used and managed.
-
#time_created ⇒ DateTime
[Required] A property indicating when the secret was created, expressed in RFC 3339 timestamp format.
-
#time_of_current_version_expiry ⇒ DateTime
An optional property indicating when the current secret version will expire, expressed in RFC 3339 timestamp format.
-
#time_of_deletion ⇒ DateTime
An optional property indicating when to delete the secret, expressed in RFC 3339 timestamp format.
-
#vault_id ⇒ String
[Required] The OCID of the vault where the secret exists.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Secret
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Secret
Initializes the object
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 263 264 |
# File 'lib/oci/vault/models/secret.rb', line 175 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. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.description = attributes[:'description'] if attributes[:'description'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = 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_id ⇒ String
[Required] The OCID of the compartment where you want to create the secret.
27 28 29 |
# File 'lib/oci/vault/models/secret.rb', line 27 def compartment_id @compartment_id end |
#current_version_number ⇒ Integer
The version number of the secret version that's currently in use.
31 32 33 |
# File 'lib/oci/vault/models/secret.rb', line 31 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\"}}
38 39 40 |
# File 'lib/oci/vault/models/secret.rb', line 38 def @defined_tags end |
#description ⇒ String
A brief description of the secret. Avoid entering confidential information.
42 43 44 |
# File 'lib/oci/vault/models/secret.rb', line 42 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\"}
49 50 51 |
# File 'lib/oci/vault/models/secret.rb', line 49 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the secret.
53 54 55 |
# File 'lib/oci/vault/models/secret.rb', line 53 def id @id 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.
58 59 60 |
# File 'lib/oci/vault/models/secret.rb', line 58 def key_id @key_id end |
#lifecycle_details ⇒ String
Additional information about the current lifecycle state of the secret.
62 63 64 |
# File 'lib/oci/vault/models/secret.rb', line 62 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The current lifecycle state of the secret.
66 67 68 |
# File 'lib/oci/vault/models/secret.rb', line 66 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.
73 74 75 |
# File 'lib/oci/vault/models/secret.rb', line 73 def @metadata end |
#secret_name ⇒ String
[Required] The user-friendly name of the secret. Avoid entering confidential information.
77 78 79 |
# File 'lib/oci/vault/models/secret.rb', line 77 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.
81 82 83 |
# File 'lib/oci/vault/models/secret.rb', line 81 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
87 88 89 |
# File 'lib/oci/vault/models/secret.rb', line 87 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
93 94 95 |
# File 'lib/oci/vault/models/secret.rb', line 93 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
99 100 101 |
# File 'lib/oci/vault/models/secret.rb', line 99 def time_of_deletion @time_of_deletion end |
#vault_id ⇒ String
[Required] The OCID of the vault where the secret exists.
103 104 105 |
# File 'lib/oci/vault/models/secret.rb', line 103 def vault_id @vault_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 |
# File 'lib/oci/vault/models/secret.rb', line 106 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_types ⇒ Object
Attribute type mapping.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'lib/oci/vault/models/secret.rb', line 130 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.
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/oci/vault/models/secret.rb', line 286 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && current_version_number == other.current_version_number && == other. && description == other.description && == other. && 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
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 331 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
311 312 313 |
# File 'lib/oci/vault/models/secret.rb', line 311 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
320 321 322 |
# File 'lib/oci/vault/models/secret.rb', line 320 def hash [compartment_id, current_version_number, , description, , 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_hash ⇒ Hash
Returns the object in the form of hash
364 365 366 367 368 369 370 371 372 373 |
# File 'lib/oci/vault/models/secret.rb', line 364 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
358 359 360 |
# File 'lib/oci/vault/models/secret.rb', line 358 def to_s to_hash.to_s end |