Class: OCI::Redis::Models::UpdateOciCacheUserDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/redis/models/update_oci_cache_user_details.rb

Overview

Details required to update an existing OCI cache user.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateOciCacheUserDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
111
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 78

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.description = attributes[:'description'] if attributes[:'description']

  self.authentication_mode = attributes[:'authenticationMode'] if attributes[:'authenticationMode']

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

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

  self.acl_string = attributes[:'aclString'] if attributes[:'aclString']

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

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

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

  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']

  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']
end

Instance Attribute Details

#acl_string ⇒ String

ACL string of OCI cache user.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 20

def acl_string
  @acl_string
end

#authentication_mode ⇒ OCI::Redis::Models::AuthenticationMode

Returns:



16
17
18
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 16

def authentication_mode
  @authentication_mode
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


36
37
38
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 36

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of OCI cache user.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 13

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


30
31
32
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 30

def freeform_tags
  @freeform_tags
end

#status ⇒ String

OCI cache user status. ON enables and OFF disables the OCI cache user to login to the associated clusters.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 24

def status
  @status
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
50
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'description',
    'authentication_mode': :'authenticationMode',
    'acl_string': :'aclString',
    'status': :'status',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 53

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'String',
    'authentication_mode': :'OCI::Redis::Models::AuthenticationMode',
    'acl_string': :'String',
    'status': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 120

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

  self.class == other.class &&
    description == other.description &&
    authentication_mode == other.authentication_mode &&
    acl_string == other.acl_string &&
    status == other.status &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



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

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


135
136
137
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 135

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



144
145
146
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 144

def hash
  [description, authentication_mode, acl_string, status, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 188

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



182
183
184
 
# File 'lib/oci/redis/models/update_oci_cache_user_details.rb', line 182

def to_s
  to_hash.to_s
end