Class: OCI::Healthchecks::Models::CreateOnDemandPingProbeDetails

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

Overview

The request body used to create an on-demand ping probe.

Constant Summary collapse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOnDemandPingProbeDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :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

[View source]

84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/healthchecks/models/create_on_demand_ping_probe_details.rb', line 84

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.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_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 

18
19
20
 
# File 'lib/oci/healthchecks/models/create_on_demand_ping_probe_details.rb', line 18

def compartment_id
  @compartment_id
end

#port ⇒ Integer

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

Returns:

  • (Integer) 

32
33
34
 
# File 'lib/oci/healthchecks/models/create_on_demand_ping_probe_details.rb', line 32

def port
  @port
end

#protocol ⇒ String

This attribute is required.

Returns:

  • (String) 

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

def protocol
  @protocol
end

#targets ⇒ Array<String>

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

Returns:

  • (Array<String>) 

22
23
24
 
# File 'lib/oci/healthchecks/models/create_on_demand_ping_probe_details.rb', line 22

def targets
  @targets
end

#timeout_in_seconds ⇒ Integer

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) 

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

def timeout_in_seconds
  @timeout_in_seconds
end

#vantage_point_names ⇒ Array<String>

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

Returns:

  • (Array<String>) 

26
27
28
 
# File 'lib/oci/healthchecks/models/create_on_demand_ping_probe_details.rb', line 26

def vantage_point_names
  @vantage_point_names
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'targets': :'targets',
    'vantage_point_names': :'vantagePointNames',
    'port': :'port',
    'timeout_in_seconds': :'timeoutInSeconds',
    'protocol': :'protocol'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

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

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

[View source]

130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/healthchecks/models/create_on_demand_ping_probe_details.rb', line 130

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

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

[View source]

165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/healthchecks/models/create_on_demand_ping_probe_details.rb', line 165

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
[View source]

145
146
147
 
# File 'lib/oci/healthchecks/models/create_on_demand_ping_probe_details.rb', line 145

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

154
155
156
 
# File 'lib/oci/healthchecks/models/create_on_demand_ping_probe_details.rb', line 154

def hash
  [compartment_id, targets, vantage_point_names, port, timeout_in_seconds, protocol].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/healthchecks/models/create_on_demand_ping_probe_details.rb', line 198

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

[View source]

192
193
194
 
# File 'lib/oci/healthchecks/models/create_on_demand_ping_probe_details.rb', line 192

def to_s
  to_hash.to_s
end