Class: OCI::Vault::Models::CreateSecretDetails
- Inherits:
-
Object
- Object
- OCI::Vault::Models::CreateSecretDetails
- Defined in:
- lib/oci/vault/models/create_secret_details.rb
Overview
The details of the secret that you want to create.
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment where you want to create the secret.
-
#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.
-
#key_id ⇒ String
The OCID of the master encryption key that is used to encrypt the secret.
-
#metadata ⇒ Hash<String, Object>
Additional metadata that you can use to provide context about how to use the secret during rotation or other administrative tasks.
-
#secret_content ⇒ OCI::Vault::Models::SecretContentDetails
This attribute is required.
-
#secret_name ⇒ String
[Required] A user-friendly name for the secret.
-
#secret_rules ⇒ Array<OCI::Vault::Models::SecretRule>
A list of rules to control how the secret is used and managed.
-
#vault_id ⇒ String
[Required] The OCID of the vault where you want to create the secret.
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 = {}) ⇒ CreateSecretDetails
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 = {}) ⇒ CreateSecretDetails
Initializes the object
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 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 169 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 112 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. = 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.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. = attributes[:'metadata'] if attributes[:'metadata'] self.secret_content = attributes[:'secretContent'] if attributes[:'secretContent'] raise 'You cannot provide both :secretContent and :secret_content' if attributes.key?(:'secretContent') && attributes.key?(:'secret_content') self.secret_content = attributes[:'secret_content'] if attributes[:'secret_content'] 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.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.
12 13 14 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 12 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. Example: {\"Operations\": {\"CostCenter\": \"42\"}}
19 20 21 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 19 def @defined_tags end |
#description ⇒ String
A brief description of the secret. Avoid entering confidential information.
23 24 25 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 23 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\"}
30 31 32 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 30 def @freeform_tags end |
#key_id ⇒ String
The OCID of the master encryption key that is used to encrypt the secret.
34 35 36 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 34 def key_id @key_id end |
#metadata ⇒ Hash<String, Object>
Additional metadata that you can use to provide context about how to use the secret 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.
41 42 43 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 41 def @metadata end |
#secret_content ⇒ OCI::Vault::Models::SecretContentDetails
This attribute is required.
45 46 47 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 45 def secret_content @secret_content end |
#secret_name ⇒ String
[Required] A user-friendly name for the secret. Secret names should be unique within a vault. Avoid entering confidential information. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.
50 51 52 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 50 def secret_name @secret_name end |
#secret_rules ⇒ Array<OCI::Vault::Models::SecretRule>
A list of rules to control how the secret is used and managed.
54 55 56 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 54 def secret_rules @secret_rules end |
#vault_id ⇒ String
[Required] The OCID of the vault where you want to create the secret.
58 59 60 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 58 def vault_id @vault_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 61 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'description': :'description', 'freeform_tags': :'freeformTags', 'key_id': :'keyId', 'metadata': :'metadata', 'secret_content': :'secretContent', 'secret_name': :'secretName', 'secret_rules': :'secretRules', 'vault_id': :'vaultId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 79 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', 'metadata': :'Hash<String, Object>', 'secret_content': :'OCI::Vault::Models::SecretContentDetails', 'secret_name': :'String', 'secret_rules': :'Array<OCI::Vault::Models::SecretRule>', 'vault_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 178 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && == other. && description == other.description && == other. && key_id == other.key_id && == other. && secret_content == other.secret_content && secret_name == other.secret_name && secret_rules == other.secret_rules && vault_id == other.vault_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 217 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
197 198 199 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 197 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
206 207 208 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 206 def hash [compartment_id, , description, , key_id, , secret_content, secret_name, secret_rules, vault_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
250 251 252 253 254 255 256 257 258 259 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 250 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
244 245 246 |
# File 'lib/oci/vault/models/create_secret_details.rb', line 244 def to_s to_hash.to_s end |