Class: OCI::LogAnalytics::Models::EncryptionKeyInfoSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/encryption_key_info_summary.rb

Overview

This is the summary of an encryption key.

Constant Summary collapse

KEY_SOURCE_ENUM = 
[
  KEY_SOURCE_ORACLE_MANAGED = 'ORACLE_MANAGED'.freeze,
  KEY_SOURCE_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'.freeze,
  KEY_SOURCE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
KEY_TYPE_ENUM = 
[
  KEY_TYPE_ACTIVE_DATA = 'ACTIVE_DATA'.freeze,
  KEY_TYPE_ARCHIVAL_DATA = 'ARCHIVAL_DATA'.freeze,
  KEY_TYPE_ALL = 'ALL'.freeze,
  KEY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EncryptionKeyInfoSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key_source (String) —

    The value to assign to the #key_source property

  • :key_id (String) —

    The value to assign to the #key_id property

  • :key_type (String) —

    The value to assign to the #key_type property



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/log_analytics/models/encryption_key_info_summary.rb', line 68

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_source = attributes[:'keySource'] if attributes[:'keySource']

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

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

  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_type = attributes[:'keyType'] if attributes[:'keyType']

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

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

Instance Attribute Details

#key_id ⇒ String

[Required] This is the key OCID of the encryption key (null if Oracle-managed).

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/log_analytics/models/encryption_key_info_summary.rb', line 31

def key_id
  @key_id
end

#key_source ⇒ String

[Required] This is the source of the encryption key.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/log_analytics/models/encryption_key_info_summary.rb', line 27

def key_source
  @key_source
end

#key_type ⇒ String

[Required] This is the type of data to be encrypted. It can be either active or archival.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/log_analytics/models/encryption_key_info_summary.rb', line 35

def key_type
  @key_type
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/log_analytics/models/encryption_key_info_summary.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key_source': :'keySource',
    'key_id': :'keyId',
    'key_type': :'keyType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/log_analytics/models/encryption_key_info_summary.rb', line 49

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key_source': :'String',
    'key_id': :'String',
    'key_type': :'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



126
127
128
129
130
131
132
133
 
# File 'lib/oci/log_analytics/models/encryption_key_info_summary.rb', line 126

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

  self.class == other.class &&
    key_source == other.key_source &&
    key_id == other.key_id &&
    key_type == other.key_type
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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/log_analytics/models/encryption_key_info_summary.rb', line 158

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


138
139
140
 
# File 'lib/oci/log_analytics/models/encryption_key_info_summary.rb', line 138

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/oci/log_analytics/models/encryption_key_info_summary.rb', line 147

def hash
  [key_source, key_id, key_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/log_analytics/models/encryption_key_info_summary.rb', line 191

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



185
186
187
 
# File 'lib/oci/log_analytics/models/encryption_key_info_summary.rb', line 185

def to_s
  to_hash.to_s
end