class OCI::Streaming::Models::CustomEncryptionKey
Custom Encryption Key which will be used for encryption by all the streams in the pool.
Constants
- KEY_STATE_ENUM
Attributes
Life cycle State of the custom key @return [String]
Custom Encryption Key (Master Key) ocid. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/streaming/models/custom_encryption_key.rb, line 30 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'kms_key_id': :'kmsKeyId', 'key_state': :'keyState' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :kms_key_id The value to assign to the {#kms_key_id} property @option attributes [String] :key_state The value to assign to the {#key_state} property
# File lib/oci/streaming/models/custom_encryption_key.rb, line 57 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.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId'] raise 'You cannot provide both :kmsKeyId and :kms_key_id' if attributes.key?(:'kmsKeyId') && attributes.key?(:'kms_key_id') self.kms_key_id = attributes[:'kms_key_id'] if attributes[:'kms_key_id'] self.key_state = attributes[:'keyState'] if attributes[:'keyState'] raise 'You cannot provide both :keyState and :key_state' if attributes.key?(:'keyState') && attributes.key?(:'key_state') self.key_state = attributes[:'key_state'] if attributes[:'key_state'] end
Attribute type mapping.
# File lib/oci/streaming/models/custom_encryption_key.rb, line 40 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'kms_key_id': :'String', 'key_state': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/streaming/models/custom_encryption_key.rb, line 96 def ==(other) return true if equal?(other) self.class == other.class && kms_key_id == other.kms_key_id && key_state == other.key_state end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/streaming/models/custom_encryption_key.rb, line 127 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/streaming/models/custom_encryption_key.rb, line 107 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/streaming/models/custom_encryption_key.rb, line 116 def hash [kms_key_id, key_state].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] key_state
Object
to be assigned
# File lib/oci/streaming/models/custom_encryption_key.rb, line 80 def key_state=(key_state) # rubocop:disable Style/ConditionalAssignment if key_state && !KEY_STATE_ENUM.include?(key_state) OCI.logger.debug("Unknown value for 'key_state' [" + key_state + "]. Mapping to 'KEY_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @key_state = KEY_STATE_UNKNOWN_ENUM_VALUE else @key_state = key_state end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/streaming/models/custom_encryption_key.rb, line 160 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/streaming/models/custom_encryption_key.rb, line 154 def to_s to_hash.to_s end
Private Instance Methods
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/streaming/models/custom_encryption_key.rb, line 177 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