Class: OCI::Redis::Models::NodeSummary

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

Overview

The details of each node in the cluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NodeSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



68
69
70
71
72
73
74
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
 
# File 'lib/oci/redis/models/node_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.private_endpoint_fqdn = attributes[:'privateEndpointFqdn'] if attributes[:'privateEndpointFqdn']

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

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

  self.private_endpoint_ip_address = attributes[:'privateEndpointIpAddress'] if attributes[:'privateEndpointIpAddress']

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

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

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

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

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

  self.shard_number = attributes[:'shardNumber'] if attributes[:'shardNumber']

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

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

Instance Attribute Details

#display_name ⇒ String

[Required] A user-friendly name of a cluster node.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#private_endpoint_fqdn ⇒ String

[Required] The fully qualified domain name (FQDN) of the API endpoint to access a specific node.

Returns:

  • (String) 


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

def private_endpoint_fqdn
  @private_endpoint_fqdn
end

#private_endpoint_ip_address ⇒ String

[Required] The private IP address of the API endpoint to access a specific node.

Returns:

  • (String) 


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

def private_endpoint_ip_address
  @private_endpoint_ip_address
end

#redis_cluster_id ⇒ String

[Required] The OCID of the cluster

Returns:

  • (String) 


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

def redis_cluster_id
  @redis_cluster_id
end

#shard_number ⇒ Integer

The shard number to which the node belongs to.

Returns:

  • (Integer) 


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

def shard_number
  @shard_number
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/redis/models/node_summary.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'private_endpoint_fqdn': :'privateEndpointFqdn',
    'private_endpoint_ip_address': :'privateEndpointIpAddress',
    'display_name': :'displayName',
    'redis_cluster_id': :'redisClusterId',
    'shard_number': :'shardNumber'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/redis/models/node_summary.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'private_endpoint_fqdn': :'String',
    'private_endpoint_ip_address': :'String',
    'display_name': :'String',
    'redis_cluster_id': :'String',
    'shard_number': :'Integer'
    # 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



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/redis/models/node_summary.rb', line 112

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

  self.class == other.class &&
    private_endpoint_fqdn == other.private_endpoint_fqdn &&
    private_endpoint_ip_address == other.private_endpoint_ip_address &&
    display_name == other.display_name &&
    redis_cluster_id == other.redis_cluster_id &&
    shard_number == other.shard_number
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/redis/models/node_summary.rb', line 146

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


126
127
128
 
# File 'lib/oci/redis/models/node_summary.rb', line 126

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [private_endpoint_fqdn, private_endpoint_ip_address, display_name, redis_cluster_id, shard_number].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/redis/models/node_summary.rb', line 179

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



173
174
175
 
# File 'lib/oci/redis/models/node_summary.rb', line 173

def to_s
  to_hash.to_s
end