Class: OCI::ObjectStorage::Models::SSECustomerKeyDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/object_storage/models/sse_customer_key_details.rb

Overview

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

Constant Summary collapse

ALGORITHM_ENUM = 
[
  ALGORITHM_AES256 = 'AES256'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SSECustomerKeyDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :algorithm (String) —

    The value to assign to the #algorithm property

  • :key (String) —

    The value to assign to the #key property

  • :key_sha256 (String) —

    The value to assign to the #key_sha256 property



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/object_storage/models/sse_customer_key_details.rb', line 63

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

Instance Attribute Details

#algorithm ⇒ String

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

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/object_storage/models/sse_customer_key_details.rb', line 19

def algorithm
  @algorithm
end

#key ⇒ String

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

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/object_storage/models/sse_customer_key_details.rb', line 24

def key
  @key
end

#key_sha256 ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/object_storage/models/sse_customer_key_details.rb', line 30

def key_sha256
  @key_sha256
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/object_storage/models/sse_customer_key_details.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'algorithm': :'algorithm',
    'key': :'key',
    'key_sha256': :'keySha256'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/object_storage/models/sse_customer_key_details.rb', line 44

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'algorithm': :'String',
    'key': :'String',
    'key_sha256': :'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



95
96
97
98
99
100
101
102
 
# File 'lib/oci/object_storage/models/sse_customer_key_details.rb', line 95

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

  self.class == other.class &&
    algorithm == other.algorithm &&
    key == other.key &&
    key_sha256 == other.key_sha256
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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/object_storage/models/sse_customer_key_details.rb', line 127

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


107
108
109
 
# File 'lib/oci/object_storage/models/sse_customer_key_details.rb', line 107

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



116
117
118
 
# File 'lib/oci/object_storage/models/sse_customer_key_details.rb', line 116

def hash
  [algorithm, key, key_sha256].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/object_storage/models/sse_customer_key_details.rb', line 160

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



154
155
156
 
# File 'lib/oci/object_storage/models/sse_customer_key_details.rb', line 154

def to_s
  to_hash.to_s
end