class OCI::Healthchecks::Models::PingProbe
This model contains all of the mutable and immutable properties for a ping probe.
Constants
- PROTOCOL_ENUM
Attributes
The OCID of the compartment. @return [String]
The region where updates must be made and where results must be fetched from.
@return [String]
The OCID of the resource. @return [String]
The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
@return [Integer]
@return [String]
A URL for fetching the probe results. @return [String]
A list of targets (hostnames or IP addresses) of the probe. @return [Array<String>]
The RFC 3339-formatted creation date and time of the probe.
@return [DateTime]
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.
@return [Integer]
A list of names of vantage points from which to execute the probe. @return [Array<String>]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :results_url The value to assign to the {#results_url} property @option attributes [String] :home_region The value to assign to the {#home_region} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [Array<String>] :targets The value to assign to the {#targets} property @option attributes [Array<String>] :vantage_point_names The value to assign to the {#vantage_point_names} property @option attributes [Integer] :port The value to assign to the {#port} property @option attributes [Integer] :timeout_in_seconds The value to assign to the {#timeout_in_seconds} property @option attributes [String] :protocol The value to assign to the {#protocol} property
# 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/healthchecks/models/ping_probe.rb, line 205 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] protocol Object
to be assigned
# File lib/oci/healthchecks/models/ping_probe.rb, line 170 def protocol=(protocol) # rubocop:disable Style/ConditionalAssignment if protocol && !PROTOCOL_ENUM.include?(protocol) OCI.logger.debug("Unknown value for 'protocol' [" + protocol + "]. Mapping to 'PROTOCOL_UNKNOWN_ENUM_VALUE'") if OCI.logger @protocol = PROTOCOL_UNKNOWN_ENUM_VALUE else @protocol = protocol end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/healthchecks/models/ping_probe.rb, line 252 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/healthchecks/models/ping_probe.rb, line 275 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end