class OCI::Vault::Models::SecretContentDetails
The content of the secret and metadata to help identify it. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Constants
- CONTENT_TYPE_ENUM
- STAGE_ENUM
Attributes
[Required] The base64-encoded content of the secret. @return [String]
Names should be unique within a secret. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. @return [String]
The rotation state of the secret content. The default is `CURRENT`, meaning that the secret is currently in use. A secret version that you mark as `PENDING` is staged and available for use, but you don't yet want to rotate it into current, active use. For example, you might create or update a secret and mark its rotation state as `PENDING` if you haven't yet updated the secret on the target system. When creating a secret, only the value `CURRENT` is applicable, although the value `LATEST` is also automatically applied. When updating a secret, you can specify a version's rotation state as either `CURRENT` or `PENDING`.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/vault/models/secret_content_details.rb, line 38 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'content_type': :'contentType', 'name': :'name', 'stage': :'stage' # rubocop:enable Style/SymbolLiteral } end
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
# File lib/oci/vault/models/secret_content_details.rb, line 64 def self.get_subtype(object_hash) type = object_hash[:'contentType'] # rubocop:disable Style/SymbolLiteral return 'OCI::Vault::Models::Base64SecretContentDetails' if type == 'BASE64' # TODO: Log a warning when the subtype is not found. 'OCI::Vault::Models::SecretContentDetails' end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :content_type The value to assign to the {#content_type} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :stage The value to assign to the {#stage} property
# File lib/oci/vault/models/secret_content_details.rb, line 83 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.content_type = attributes[:'contentType'] if attributes[:'contentType'] raise 'You cannot provide both :contentType and :content_type' if attributes.key?(:'contentType') && attributes.key?(:'content_type') self.content_type = attributes[:'content_type'] if attributes[:'content_type'] self.name = attributes[:'name'] if attributes[:'name'] self.stage = attributes[:'stage'] if attributes[:'stage'] self.stage = "CURRENT" if stage.nil? && !attributes.key?(:'stage') # rubocop:disable Style/StringLiterals end
Attribute type mapping.
# File lib/oci/vault/models/secret_content_details.rb, line 49 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'content_type': :'String', 'name': :'String', 'stage': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/vault/models/secret_content_details.rb, line 124 def ==(other) return true if equal?(other) self.class == other.class && content_type == other.content_type && name == other.name && stage == other.stage end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/vault/models/secret_content_details.rb, line 156 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
Custom attribute writer method checking allowed values (enum). @param [Object] content_type
Object
to be assigned
# File lib/oci/vault/models/secret_content_details.rb, line 105 def content_type=(content_type) raise "Invalid value for 'content_type': this must be one of the values in CONTENT_TYPE_ENUM." if content_type && !CONTENT_TYPE_ENUM.include?(content_type) @content_type = content_type end
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/vault/models/secret_content_details.rb, line 136 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/vault/models/secret_content_details.rb, line 145 def hash [content_type, name, stage].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] stage Object
to be assigned
# File lib/oci/vault/models/secret_content_details.rb, line 113 def stage=(stage) raise "Invalid value for 'stage': this must be one of the values in STAGE_ENUM." if stage && !STAGE_ENUM.include?(stage) @stage = stage end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/vault/models/secret_content_details.rb, line 189 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/vault/models/secret_content_details.rb, line 183 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/vault/models/secret_content_details.rb, line 206 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end