Class: OCI::KeyManagement::Models::GeneratedKey

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

Overview

GeneratedKey model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GeneratedKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :ciphertext (String) —

    The value to assign to the #ciphertext property

  • :plaintext (String) —

    The value to assign to the #plaintext property

  • :plaintext_checksum (String) —

    The value to assign to the #plaintext_checksum property



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/key_management/models/generated_key.rb', line 59

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

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

  self.plaintext_checksum = attributes[:'plaintextChecksum'] if attributes[:'plaintextChecksum']

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

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

Instance Attribute Details

#ciphertext ⇒ String

[Required] The encrypted generated data encryption key.

Returns:

  • (String) 


11
12
13
 
# File 'lib/oci/key_management/models/generated_key.rb', line 11

def ciphertext
  @ciphertext
end

#plaintext ⇒ String

The plaintext generated data encryption key, a base64-encoded sequence of random bytes, which is included if the GenerateDataEncryptionKey request includes the "includePlaintextKey" parameter and sets its value to ‘true’.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/key_management/models/generated_key.rb', line 19

def plaintext
  @plaintext
end

#plaintext_checksum ⇒ String

The checksum of the plaintext generated data encryption key, which is included if the GenerateDataEncryptionKey request includes the "includePlaintextKey parameter and sets its value to ‘true’.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/key_management/models/generated_key.rb', line 26

def plaintext_checksum
  @plaintext_checksum
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
 
# File 'lib/oci/key_management/models/generated_key.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'ciphertext': :'ciphertext',
    'plaintext': :'plaintext',
    'plaintext_checksum': :'plaintextChecksum'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/key_management/models/generated_key.rb', line 40

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



83
84
85
86
87
88
89
90
 
# File 'lib/oci/key_management/models/generated_key.rb', line 83

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

  self.class == other.class &&
    ciphertext == other.ciphertext &&
    plaintext == other.plaintext &&
    plaintext_checksum == other.plaintext_checksum
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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/key_management/models/generated_key.rb', line 115

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


95
96
97
 
# File 'lib/oci/key_management/models/generated_key.rb', line 95

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



104
105
106
 
# File 'lib/oci/key_management/models/generated_key.rb', line 104

def hash
  [ciphertext, plaintext, plaintext_checksum].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/key_management/models/generated_key.rb', line 148

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



142
143
144
 
# File 'lib/oci/key_management/models/generated_key.rb', line 142

def to_s
  to_hash.to_s
end