Class: OCI::KeyManagement::Models::KeyShape

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

Overview

The cryptographic properties of a key.

Constant Summary collapse

ALGORITHM_ENUM =
[
  ALGORITHM_AES = 'AES'.freeze,
  ALGORITHM_RSA = 'RSA'.freeze,
  ALGORITHM_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KeyShape

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

  • :length (Integer)

    The value to assign to the #length property



54
55
56
57
58
59
60
61
62
63
# File 'lib/oci/key_management/models/key_shape.rb', line 54

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

Instance Attribute Details

#algorithmString

[Required] The algorithm used by a key's key versions to encrypt or decrypt.

Returns:

  • (String)


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

def algorithm
  @algorithm
end

#lengthInteger

[Required] The length of the key, expressed as an integer. Values of 16, 24, or 32 are supported.

Returns:

  • (Integer)


24
25
26
# File 'lib/oci/key_management/models/key_shape.rb', line 24

def length
  @length
end

Class Method Details

.attribute_mapObject

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



27
28
29
30
31
32
33
34
# File 'lib/oci/key_management/models/key_shape.rb', line 27

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

.swagger_typesObject

Attribute type mapping.



37
38
39
40
41
42
43
44
# File 'lib/oci/key_management/models/key_shape.rb', line 37

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



85
86
87
88
89
90
91
# File 'lib/oci/key_management/models/key_shape.rb', line 85

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

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



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

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


96
97
98
# File 'lib/oci/key_management/models/key_shape.rb', line 96

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



105
106
107
# File 'lib/oci/key_management/models/key_shape.rb', line 105

def hash
  [algorithm, length].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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



143
144
145
# File 'lib/oci/key_management/models/key_shape.rb', line 143

def to_s
  to_hash.to_s
end