class OCI::KeyManagement::Models::KeyShape

The cryptographic properties of a key.

Constants

ALGORITHM_ENUM
CURVE_ID_ENUM

Attributes

algorithm[R]

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

curve_id[R]

Supported curve IDs for ECDSA keys. @return [String]

length[RW]

[Required] The length of the key in bytes, expressed as an integer. Supported values include the following:

- AES: 16, 24, or 32
- RSA: 256, 384, or 512
- ECDSA: 32, 48, or 66

@return [Integer]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/key_management/models/key_shape.rb, line 42
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'algorithm': :'algorithm',
    'length': :'length',
    'curve_id': :'curveId'
    # 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 [Integer] :length The value to assign to the {#length} property @option attributes [String] :curve_id The value to assign to the {#curve_id} property

# File lib/oci/key_management/models/key_shape.rb, line 72
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']

  self.curve_id = attributes[:'curveId'] if attributes[:'curveId']

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

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

Attribute type mapping.

# File lib/oci/key_management/models/key_shape.rb, line 53
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'algorithm': :'String',
    'length': :'Integer',
    'curve_id': :'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/key_management/models/key_shape.rb, line 122
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    algorithm == other.algorithm &&
    length == other.length &&
    curve_id == other.curve_id
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/key_management/models/key_shape.rb, line 93
def algorithm=(algorithm)
  # rubocop:disable Style/ConditionalAssignment
  if algorithm && !ALGORITHM_ENUM.include?(algorithm)
    OCI.logger.debug("Unknown value for 'algorithm' [" + algorithm + "]. Mapping to 'ALGORITHM_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @algorithm = ALGORITHM_UNKNOWN_ENUM_VALUE
  else
    @algorithm = algorithm
  end
  # rubocop:enable Style/ConditionalAssignment
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/key_management/models/key_shape.rb, line 154
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
curve_id=(curve_id) click to toggle source

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

# File lib/oci/key_management/models/key_shape.rb, line 106
def curve_id=(curve_id)
  # rubocop:disable Style/ConditionalAssignment
  if curve_id && !CURVE_ID_ENUM.include?(curve_id)
    OCI.logger.debug("Unknown value for 'curve_id' [" + curve_id + "]. Mapping to 'CURVE_ID_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @curve_id = CURVE_ID_UNKNOWN_ENUM_VALUE
  else
    @curve_id = curve_id
  end
  # rubocop:enable Style/ConditionalAssignment
end
eql?(other) click to toggle source

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

# File lib/oci/key_management/models/key_shape.rb, line 134
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/key_management/models/key_shape.rb, line 143
def hash
  [algorithm, length, curve_id].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/key_management/models/key_shape.rb, line 187
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/key_management/models/key_shape.rb, line 181
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/key_management/models/key_shape.rb, line 204
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