Class: OCI::VnMonitoring::Models::Endpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vn_monitoring/models/endpoint.rb

Overview

Information describing a source or destination in a PathAnalyzerTest resource.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_IP_ADDRESS = 'IP_ADDRESS'.freeze,
  TYPE_SUBNET = 'SUBNET'.freeze,
  TYPE_COMPUTE_INSTANCE = 'COMPUTE_INSTANCE'.freeze,
  TYPE_VNIC = 'VNIC'.freeze,
  TYPE_LOAD_BALANCER = 'LOAD_BALANCER'.freeze,
  TYPE_LOAD_BALANCER_LISTENER = 'LOAD_BALANCER_LISTENER'.freeze,
  TYPE_NETWORK_LOAD_BALANCER = 'NETWORK_LOAD_BALANCER'.freeze,
  TYPE_NETWORK_LOAD_BALANCER_LISTENER = 'NETWORK_LOAD_BALANCER_LISTENER'.freeze,
  TYPE_VLAN = 'VLAN'.freeze,
  TYPE_ON_PREM = 'ON_PREM'.freeze,
  TYPE_PRIVATE_SERVICE_ACCESS = 'PRIVATE_SERVICE_ACCESS'.freeze,
  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 = {}) ⇒ Endpoint

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property



83
84
85
86
87
88
89
90
 
# File 'lib/oci/vn_monitoring/models/endpoint.rb', line 83

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

Instance Attribute Details

#type ⇒ String

[Required] The type of the Endpoint.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/vn_monitoring/models/endpoint.rb', line 31

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
 
# File 'lib/oci/vn_monitoring/models/endpoint.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/vn_monitoring/models/endpoint.rb', line 56

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::VnMonitoring::Models::NetworkLoadBalancerListenerEndpoint' if type == 'NETWORK_LOAD_BALANCER_LISTENER'
  return 'OCI::VnMonitoring::Models::ComputeInstanceEndpoint' if type == 'COMPUTE_INSTANCE'
  return 'OCI::VnMonitoring::Models::NetworkLoadBalancerEndpoint' if type == 'NETWORK_LOAD_BALANCER'
  return 'OCI::VnMonitoring::Models::OnPremEndpoint' if type == 'ON_PREM'
  return 'OCI::VnMonitoring::Models::PrivateServiceAccessEndpoint' if type == 'PRIVATE_SERVICE_ACCESS'
  return 'OCI::VnMonitoring::Models::LoadBalancerEndpoint' if type == 'LOAD_BALANCER'
  return 'OCI::VnMonitoring::Models::VnicEndpoint' if type == 'VNIC'
  return 'OCI::VnMonitoring::Models::IpAddressEndpoint' if type == 'IP_ADDRESS'
  return 'OCI::VnMonitoring::Models::VlanEndpoint' if type == 'VLAN'
  return 'OCI::VnMonitoring::Models::SubnetEndpoint' if type == 'SUBNET'
  return 'OCI::VnMonitoring::Models::LoadBalancerListenerEndpoint' if type == 'LOAD_BALANCER_LISTENER'

  # TODO: Log a warning when the subtype is not found.
  'OCI::VnMonitoring::Models::Endpoint'
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
 
# File 'lib/oci/vn_monitoring/models/endpoint.rb', line 43

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



112
113
114
115
116
117
 
# File 'lib/oci/vn_monitoring/models/endpoint.rb', line 112

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

  self.class == other.class &&
    type == other.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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/vn_monitoring/models/endpoint.rb', line 142

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


122
123
124
 
# File 'lib/oci/vn_monitoring/models/endpoint.rb', line 122

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



131
132
133
 
# File 'lib/oci/vn_monitoring/models/endpoint.rb', line 131

def hash
  [type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/vn_monitoring/models/endpoint.rb', line 175

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



169
170
171
 
# File 'lib/oci/vn_monitoring/models/endpoint.rb', line 169

def to_s
  to_hash.to_s
end