Class: OCI::KeyManagement::Models::DecryptDataDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/key_management/models/decrypt_data_details.rb

Overview

DecryptDataDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DecryptDataDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :associated_data (Hash<String, String>)

    The value to assign to the #associated_data property

  • :ciphertext (String)

    The value to assign to the #ciphertext property

  • :key_id (String)

    The value to assign to the #key_id property

  • :logging_context (Hash<String, String>)

    The value to assign to the #logging_context property



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/oci/key_management/models/decrypt_data_details.rb', line 64

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.associated_data = attributes[:'associatedData'] if attributes[:'associatedData']

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

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

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

  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.logging_context = attributes[:'loggingContext'] if attributes[:'loggingContext']

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

  self.logging_context = attributes[:'logging_context'] if attributes[:'logging_context']
end

Instance Attribute Details

#associated_dataHash<String, String>

Information that can be used to provide an encryption context for the encrypted data. The length of the string representation of the associated data must be fewer than 4096 characters.

Returns:

  • (Hash<String, String>)


14
15
16
# File 'lib/oci/key_management/models/decrypt_data_details.rb', line 14

def associated_data
  @associated_data
end

#ciphertextString

[Required] The encrypted data to decrypt.

Returns:

  • (String)


18
19
20
# File 'lib/oci/key_management/models/decrypt_data_details.rb', line 18

def ciphertext
  @ciphertext
end

#key_idString

[Required] The OCID of the key used to encrypt the ciphertext.

Returns:

  • (String)


22
23
24
# File 'lib/oci/key_management/models/decrypt_data_details.rb', line 22

def key_id
  @key_id
end

#logging_contextHash<String, String>

Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in audit logs when audit logging is enabled.

Returns:

  • (Hash<String, String>)


28
29
30
# File 'lib/oci/key_management/models/decrypt_data_details.rb', line 28

def logging_context
  @logging_context
end

Class Method Details

.attribute_mapObject

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



31
32
33
34
35
36
37
38
39
40
# File 'lib/oci/key_management/models/decrypt_data_details.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'associated_data': :'associatedData',
    'ciphertext': :'ciphertext',
    'key_id': :'keyId',
    'logging_context': :'loggingContext'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'associated_data': :'Hash<String, String>',
    'ciphertext': :'String',
    'key_id': :'String',
    'logging_context': :'Hash<String, 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



98
99
100
101
102
103
104
105
106
# File 'lib/oci/key_management/models/decrypt_data_details.rb', line 98

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

  self.class == other.class &&
    associated_data == other.associated_data &&
    ciphertext == other.ciphertext &&
    key_id == other.key_id &&
    logging_context == other.logging_context
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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/oci/key_management/models/decrypt_data_details.rb', line 131

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


111
112
113
# File 'lib/oci/key_management/models/decrypt_data_details.rb', line 111

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



120
121
122
# File 'lib/oci/key_management/models/decrypt_data_details.rb', line 120

def hash
  [associated_data, ciphertext, key_id, logging_context].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



164
165
166
167
168
169
170
171
172
173
# File 'lib/oci/key_management/models/decrypt_data_details.rb', line 164

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



158
159
160
# File 'lib/oci/key_management/models/decrypt_data_details.rb', line 158

def to_s
  to_hash.to_s
end