class OCI::ObjectStorage::Models::SSECustomerKeyDetails

Specifies the details of the customer-provided encryption key (SSE-C) associated with an object.

Constants

ALGORITHM_ENUM

Attributes

algorithm[R]

[Required] Specifies the encryption algorithm. The only supported value is "AES256".

@return [String]

key[RW]

[Required] Specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the object data.

@return [String]

key_sha256[RW]

[Required] Specifies the base64-encoded SHA256 hash of the encryption key. This value is used to check the integrity of the encryption key.

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/object_storage/models/sse_customer_key_details.rb, line 32
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'algorithm': :'algorithm',
    'key': :'key',
    'key_sha256': :'keySha256'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :algorithm The value to assign to the {#algorithm} property @option attributes [String] :key The value to assign to the {#key} property @option attributes [String] :key_sha256 The value to assign to the {#key_sha256} property

# File lib/oci/object_storage/models/sse_customer_key_details.rb, line 62
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.algorithm = attributes[:'algorithm'] if attributes[:'algorithm']

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

  self.key_sha256 = attributes[:'keySha256'] if attributes[:'keySha256']

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

  self.key_sha256 = attributes[:'key_sha256'] if attributes[:'key_sha256']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/object_storage/models/sse_customer_key_details.rb, line 43
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'algorithm': :'String',
    'key': :'String',
    'key_sha256': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/object_storage/models/sse_customer_key_details.rb, line 94
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    algorithm == other.algorithm &&
    key == other.key &&
    key_sha256 == other.key_sha256
end
algorithm=(algorithm) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] algorithm Object to be assigned

# File lib/oci/object_storage/models/sse_customer_key_details.rb, line 83
def algorithm=(algorithm)
  raise "Invalid value for 'algorithm': this must be one of the values in ALGORITHM_ENUM." if algorithm && !ALGORITHM_ENUM.include?(algorithm)

  @algorithm = algorithm
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/object_storage/models/sse_customer_key_details.rb, line 126
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/object_storage/models/sse_customer_key_details.rb, line 106
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/object_storage/models/sse_customer_key_details.rb, line 115
def hash
  [algorithm, key, key_sha256].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/object_storage/models/sse_customer_key_details.rb, line 159
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/object_storage/models/sse_customer_key_details.rb, line 153
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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/object_storage/models/sse_customer_key_details.rb, line 176
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