Class: OCI::Healthchecks::Models::CreateOnDemandHttpProbeDetails

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

Overview

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

Constant Summary collapse

PROTOCOL_ENUM = 
[
  PROTOCOL_HTTP = 'HTTP'.freeze,
  PROTOCOL_HTTPS = 'HTTPS'.freeze
].freeze
METHOD_ENUM = 
[
  METHOD_GET = 'GET'.freeze,
  METHOD_HEAD = 'HEAD'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOnDemandHttpProbeDetails

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

  • :method (String) —

    The value to assign to the #method property

  • :path (String) —

    The value to assign to the #path property

  • :headers (Hash<String, String>) —

    The value to assign to the #headers property



110
111
112
113
114
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
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 110

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']

  self.method = attributes[:'method'] if attributes[:'method']
  self.method = "HEAD" if method.nil? && !attributes.key?(:'method') # rubocop:disable Style/StringLiterals

  self.path = attributes[:'path'] if attributes[:'path']
  self.path = "/" if path.nil? && !attributes.key?(:'path') # rubocop:disable Style/StringLiterals

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#headers ⇒ Hash<String, String>

A dictionary of HTTP request headers.

Note: Monitors and probes do not support the use of the ‘Authorization` HTTP header.

Returns:

  • (Hash<String, String>) 


59
60
61
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 59

def headers
  @headers
end

#method ⇒ String

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 48

def method
  @method
end

#path ⇒ String

The optional URL path to probe, including query parameters.

Returns:

  • (String) 


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

def path
  @path
end

#port ⇒ Integer

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

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 35

def port
  @port
end

#protocol ⇒ String

This attribute is required.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 45

def protocol
  @protocol
end

#targets ⇒ Array<String>

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

Returns:

  • (Array<String>) 


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

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) 


41
42
43
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 41

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>) 


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

def vantage_point_names
  @vantage_point_names
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 62

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',
    'method': :'method',
    'path': :'path',
    'headers': :'headers'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 79

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',
    'method': :'String',
    'path': :'String',
    'headers': :'Hash<String, 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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 172

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 &&
    method == other.method &&
    path == other.path &&
    headers == other.headers
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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 210

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


190
191
192
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 190

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



199
200
201
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 199

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 243

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



237
238
239
 
# File 'lib/oci/healthchecks/models/create_on_demand_http_probe_details.rb', line 237

def to_s
  to_hash.to_s
end