Class: OCI::Healthchecks::Models::HealthChecksVantagePointSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb

Overview

Information about a vantage point.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HealthChecksVantagePointSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb', line 81

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

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

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

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

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

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

Instance Attribute Details

#display_nameString

The display name for the vantage point. Display names are determined by the best information available and may change over time.

Returns:

  • (String)


14
15
16
# File 'lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb', line 14

def display_name
  @display_name
end

#geoOCI::Healthchecks::Models::Geolocation



28
29
30
# File 'lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb', line 28

def geo
  @geo
end

#nameString

The unique, permanent name for the vantage point.

Returns:

  • (String)


25
26
27
# File 'lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb', line 25

def name
  @name
end

#provider_nameString

The organization on whose infrastructure this vantage point resides. Provider names are not unique, as Oracle Cloud Infrastructure maintains many vantage points in each major provider.

Returns:

  • (String)


21
22
23
# File 'lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb', line 21

def provider_name
  @provider_name
end

#routingArray<OCI::Healthchecks::Models::Routing>

An array of objects that describe how traffic to this vantage point is routed, including which prefixes and ASNs connect it to the internet.

The addresses are sorted from the most-specific to least-specific prefix (the smallest network to largest network). When a prefix has multiple origin ASNs (MOAS routing), they are sorted by weight (highest to lowest). Weight is determined by the total percentage of peers observing the prefix originating from an ASN. Only present if fields includes routing. The field will be null if the address's routing information is unknown.



42
43
44
# File 'lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb', line 42

def routing
  @routing
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'provider_name': :'providerName',
    'name': :'name',
    'geo': :'geo',
    'routing': :'routing'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
# File 'lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb', line 58

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'provider_name': :'String',
    'name': :'String',
    'geo': :'OCI::Healthchecks::Models::Geolocation',
    'routing': :'Array<OCI::Healthchecks::Models::Routing>'
    # 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



113
114
115
116
117
118
119
120
121
122
# File 'lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb', line 113

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

  self.class == other.class &&
    display_name == other.display_name &&
    provider_name == other.provider_name &&
    name == other.name &&
    geo == other.geo &&
    routing == other.routing
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



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

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


127
128
129
# File 'lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb', line 127

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



136
137
138
# File 'lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb', line 136

def hash
  [display_name, provider_name, name, geo, routing].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



180
181
182
183
184
185
186
187
188
189
# File 'lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb', line 180

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



174
175
176
# File 'lib/oci/healthchecks/models/health_checks_vantage_point_summary.rb', line 174

def to_s
  to_hash.to_s
end