class OCI::KeyManagement::Models::VerifyDataDetails

VerifyDataDetails model.

Constants

MESSAGE_TYPE_ENUM
SIGNING_ALGORITHM_ENUM

Attributes

key_id[RW]

[Required] The OCID of the key used to sign the message. @return [String]

key_version_id[RW]

[Required] The OCID of the key version used to sign the message. @return [String]

message[RW]

[Required] The base64-encoded binary data object denoting the message or message digest to sign. You can have a message up to 4096 bytes in size. To sign a larger message, provide the message digest. @return [String]

message_type[R]

Denotes whether the value of the message parameter is a raw message or a message digest. The default value, `RAW`, indicates a message. To indicate a message digest, use `DIGEST`.

@return [String]

signature[RW]

[Required] The base64-encoded binary data object denoting the cryptographic signature generated for the message.

@return [String]

signing_algorithm[R]

[Required] The algorithm to use to sign the message or message digest. For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with different hashing algorithms. For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. When you pass a message digest for signing, ensure that you specify the same hashing algorithm as used when creating the message digest.

@return [String]

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/verify_data_details.rb, line 63
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key_id': :'keyId',
    'key_version_id': :'keyVersionId',
    'signature': :'signature',
    'message_type': :'messageType',
    'message': :'message',
    'signing_algorithm': :'signingAlgorithm'
    # 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] :key_id The value to assign to the {#key_id} property @option attributes [String] :key_version_id The value to assign to the {#key_version_id} property @option attributes [String] :signature The value to assign to the {#signature} property @option attributes [String] :message_type The value to assign to the {#message_type} property @option attributes [String] :message The value to assign to the {#message} property @option attributes [String] :signing_algorithm The value to assign to the {#signing_algorithm} property

# File lib/oci/key_management/models/verify_data_details.rb, line 102
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.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.key_version_id = attributes[:'keyVersionId'] if attributes[:'keyVersionId']

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

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

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

  self.message_type = attributes[:'messageType'] if attributes[:'messageType']
  self.message_type = "RAW" if message_type.nil? && !attributes.key?(:'messageType') # rubocop:disable Style/StringLiterals

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

  self.message_type = attributes[:'message_type'] if attributes[:'message_type']
  self.message_type = "RAW" if message_type.nil? && !attributes.key?(:'messageType') && !attributes.key?(:'message_type') # rubocop:disable Style/StringLiterals

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

  self.signing_algorithm = attributes[:'signingAlgorithm'] if attributes[:'signingAlgorithm']

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

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

Attribute type mapping.

# File lib/oci/key_management/models/verify_data_details.rb, line 77
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key_id': :'String',
    'key_version_id': :'String',
    'signature': :'String',
    'message_type': :'String',
    'message': :'String',
    'signing_algorithm': :'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/verify_data_details.rb, line 162
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    key_id == other.key_id &&
    key_version_id == other.key_version_id &&
    signature == other.signature &&
    message_type == other.message_type &&
    message == other.message &&
    signing_algorithm == other.signing_algorithm
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/verify_data_details.rb, line 197
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) click to toggle source

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

# File lib/oci/key_management/models/verify_data_details.rb, line 177
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/verify_data_details.rb, line 186
def hash
  [key_id, key_version_id, signature, message_type, message, signing_algorithm].hash
end
message_type=(message_type) click to toggle source

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

# File lib/oci/key_management/models/verify_data_details.rb, line 143
def message_type=(message_type)
  raise "Invalid value for 'message_type': this must be one of the values in MESSAGE_TYPE_ENUM." if message_type && !MESSAGE_TYPE_ENUM.include?(message_type)

  @message_type = message_type
end
signing_algorithm=(signing_algorithm) click to toggle source

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

# File lib/oci/key_management/models/verify_data_details.rb, line 151
def signing_algorithm=(signing_algorithm)
  raise "Invalid value for 'signing_algorithm': this must be one of the values in SIGNING_ALGORITHM_ENUM." if signing_algorithm && !SIGNING_ALGORITHM_ENUM.include?(signing_algorithm)

  @signing_algorithm = signing_algorithm
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/verify_data_details.rb, line 230
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/verify_data_details.rb, line 224
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/verify_data_details.rb, line 247
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