Class: OCI::Healthchecks::Models::PingProbe

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

Overview

This model contains all of the mutable and immutable properties for a ping probe.

Constant Summary collapse

PROTOCOL_ENUM =
[
  PROTOCOL_ICMP = 'ICMP'.freeze,
  PROTOCOL_TCP = 'TCP'.freeze,
  PROTOCOL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PingProbe

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String)

    The value to assign to the #id property

  • :results_url (String)

    The value to assign to the #results_url property

  • :home_region (String)

    The value to assign to the #home_region property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :targets (Array<String>)

    The value to assign to the #targets property

  • :vantage_point_names (Array<String>)

    The value to assign to the #vantage_point_names property

  • :port (Integer)

    The value to assign to the #port property

  • :timeout_in_seconds (Integer)

    The value to assign to the #timeout_in_seconds property

  • :protocol (String)

    The value to assign to the #protocol property



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
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/healthchecks/models/ping_probe.rb', line 115

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

  self.results_url = attributes[:'resultsUrl'] if attributes[:'resultsUrl']

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

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

  self.home_region = attributes[:'homeRegion'] if attributes[:'homeRegion']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

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

  self.vantage_point_names = attributes[:'vantagePointNames'] if attributes[:'vantagePointNames']

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

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

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

  self.timeout_in_seconds = attributes[:'timeoutInSeconds'] if attributes[:'timeoutInSeconds']

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

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

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

Instance Attribute Details

#compartment_idString

The OCID of the compartment.

Returns:

  • (String)


38
39
40
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 38

def compartment_id
  @compartment_id
end

#home_regionString

The region where updates must be made and where results must be fetched from.

Returns:

  • (String)


29
30
31
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 29

def home_region
  @home_region
end

#idString

The OCID of the resource.

Returns:

  • (String)


20
21
22
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 20

def id
  @id
end

#portInteger

The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.

Returns:

  • (Integer)


52
53
54
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 52

def port
  @port
end

#protocolString

Returns:

  • (String)


61
62
63
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 61

def protocol
  @protocol
end

#results_urlString

A URL for fetching the probe results.

Returns:

  • (String)


24
25
26
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 24

def results_url
  @results_url
end

#targetsArray<String>

A list of targets (hostnames or IP addresses) of the probe.

Returns:

  • (Array<String>)


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

def targets
  @targets
end

#time_createdDateTime

The RFC 3339-formatted creation date and time of the probe.

Returns:

  • (DateTime)


34
35
36
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 34

def time_created
  @time_created
end

#timeout_in_secondsInteger

The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.

Returns:

  • (Integer)


58
59
60
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 58

def timeout_in_seconds
  @timeout_in_seconds
end

#vantage_point_namesArray<String>

A list of names of vantage points from which to execute the probe.

Returns:

  • (Array<String>)


46
47
48
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 46

def vantage_point_names
  @vantage_point_names
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'results_url': :'resultsUrl',
    'home_region': :'homeRegion',
    'time_created': :'timeCreated',
    'compartment_id': :'compartmentId',
    'targets': :'targets',
    'vantage_point_names': :'vantagePointNames',
    'port': :'port',
    'timeout_in_seconds': :'timeoutInSeconds',
    'protocol': :'protocol'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 82

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'results_url': :'String',
    'home_region': :'String',
    'time_created': :'DateTime',
    'compartment_id': :'String',
    'targets': :'Array<String>',
    'vantage_point_names': :'Array<String>',
    'port': :'Integer',
    'timeout_in_seconds': :'Integer',
    'protocol': :'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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 186

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

  self.class == other.class &&
    id == other.id &&
    results_url == other.results_url &&
    home_region == other.home_region &&
    time_created == other.time_created &&
    compartment_id == other.compartment_id &&
    targets == other.targets &&
    vantage_point_names == other.vantage_point_names &&
    port == other.port &&
    timeout_in_seconds == other.timeout_in_seconds &&
    protocol == other.protocol
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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 225

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


205
206
207
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 205

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



214
215
216
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 214

def hash
  [id, results_url, home_region, time_created, compartment_id, targets, vantage_point_names, port, timeout_in_seconds, protocol].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



258
259
260
261
262
263
264
265
266
267
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 258

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



252
253
254
# File 'lib/oci/healthchecks/models/ping_probe.rb', line 252

def to_s
  to_hash.to_s
end