Class: OCI::Redis::Models::CreateOciCacheUserDetails

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

Overview

Details required to create a new OCI cache user.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOciCacheUserDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :authentication_mode (OCI::Redis::Models::AuthenticationMode) —

    The value to assign to the #authentication_mode property

  • :acl_string (String) —

    The value to assign to the #acl_string property

  • :status (String) —

    The value to assign to the #status property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 93

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  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

[Required] ACL string of OCI cache user.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 29

def acl_string
  @acl_string
end

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

This attribute is required.

Returns:



25
26
27
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 25

def authentication_mode
  @authentication_mode
end

#compartment_id ⇒ String

[Required] OCI cache user compartment ID.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 21

def compartment_id
  @compartment_id
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>>) 


45
46
47
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 45

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] Description of OCI cache user.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 17

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>) 


39
40
41
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 39

def freeform_tags
  @freeform_tags
end

#name ⇒ String

[Required] OCI cache user name is required to connect to an OCI cache cluster.

Returns:

  • (String) 


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

def name
  @name
end

#status ⇒ String

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

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 33

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 48

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'compartment_id': :'compartmentId',
    '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.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 64

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'compartment_id': :'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



143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 143

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

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 180

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


160
161
162
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 160

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



169
170
171
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 169

def hash
  [name, description, compartment_id, 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



213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 213

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



207
208
209
 
# File 'lib/oci/redis/models/create_oci_cache_user_details.rb', line 207

def to_s
  to_hash.to_s
end