Class: OCI::KeyManagement::Models::UpdateKeyDetails

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

Overview

The details of the Key that you wish to update.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateKeyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/key_management/models/update_key_details.rb', line 75

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.is_auto_rotation_enabled = attributes[:'isAutoRotationEnabled'] unless attributes[:'isAutoRotationEnabled'].nil?

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

  self.is_auto_rotation_enabled = attributes[:'is_auto_rotation_enabled'] unless attributes[:'is_auto_rotation_enabled'].nil?

  self.auto_key_rotation_details = attributes[:'autoKeyRotationDetails'] if attributes[:'autoKeyRotationDetails']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

Instance Attribute Details

#auto_key_rotation_details ⇒ OCI::KeyManagement::Models::AutoKeyRotationDetails

Returns:



16
17
18
 
# File 'lib/oci/key_management/models/update_key_details.rb', line 16

def auto_key_rotation_details
  @auto_key_rotation_details
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


23
24
25
 
# File 'lib/oci/key_management/models/update_key_details.rb', line 23

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/key_management/models/update_key_details.rb', line 29

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


36
37
38
 
# File 'lib/oci/key_management/models/update_key_details.rb', line 36

def freeform_tags
  @freeform_tags
end

#is_auto_rotation_enabled ⇒ BOOLEAN

A parameter specifying whether the auto key rotation is enabled or not.

Returns:

  • (BOOLEAN) 


13
14
15
 
# File 'lib/oci/key_management/models/update_key_details.rb', line 13

def is_auto_rotation_enabled
  @is_auto_rotation_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/key_management/models/update_key_details.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_auto_rotation_enabled': :'isAutoRotationEnabled',
    'auto_key_rotation_details': :'autoKeyRotationDetails',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_auto_rotation_enabled': :'BOOLEAN',
    'auto_key_rotation_details': :'OCI::KeyManagement::Models::AutoKeyRotationDetails',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, 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



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/key_management/models/update_key_details.rb', line 119

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

  self.class == other.class &&
    is_auto_rotation_enabled == other.is_auto_rotation_enabled &&
    auto_key_rotation_details == other.auto_key_rotation_details &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags
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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/key_management/models/update_key_details.rb', line 153

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


133
134
135
 
# File 'lib/oci/key_management/models/update_key_details.rb', line 133

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



142
143
144
 
# File 'lib/oci/key_management/models/update_key_details.rb', line 142

def hash
  [is_auto_rotation_enabled, auto_key_rotation_details, defined_tags, display_name, freeform_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/key_management/models/update_key_details.rb', line 186

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



180
181
182
 
# File 'lib/oci/key_management/models/update_key_details.rb', line 180

def to_s
  to_hash.to_s
end