Class: MintPress::OracleTrafficDirector::HealthCheck

Inherits:

Object

• Object
• MintPress::OracleTrafficDirector::HealthCheck

Includes:

MintLogger, Mixins::Properties, OtdCommon

Defined in:

src/oracle-otd/lib/oracle-otd/generated/health_check.rb

Overview

set the following health-check properties for an origin server pool:

Properties (Read/Write)

• #name ⇒ String
  
  Property Attributes

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 27
  
  property :name, type: String

• #protocol ⇒ String
  'Health check mechanism. Range of values: http, tcp or command Default: origin server pool type'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 32
  
  property :protocol, description: 'Health check mechanism.
  Range of values: http, tcp or command
  Default: origin server pool type', set_prop: true, type: String

• #interval ⇒ Float
  'The time interval in seconds between two health check pings. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 30'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 38
  
  property :interval, description: 'The time interval in seconds between two health check pings.
  Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive.
  Default: 30', set_prop: true, type: Float

• #timeout ⇒ Float
  'The timeout value in seconds for a ping request or connection. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 5'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 44
  
  property :timeout, description: 'The timeout value in seconds for a ping request or connection.
  Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive.
  Default: 5', set_prop: true, type: Float

• #failover_threshold ⇒ Integer
  'The number of consecutive failures for marking a server down. Range of values: 1 - 256 Default: 3'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 50
  
  property :failover_threshold, description: 'The number of consecutive failures for marking a server down.
  Range of values: 1 - 256
  Default: 3', set_prop: true, type: Integer

• #request_method ⇒ String
  'The method used in HTTP ping requests. Range of values: OPTIONS or GET Default: OPTIONS'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 56
  
  property :request_method, description: 'The method used in HTTP ping requests.
  Range of values: OPTIONS or GET
  Default: OPTIONS', set_prop: true, type: String

• #request_uri ⇒ String
  'The URI to use for HTTP health check request. Range of values: URI (virtual directory) that begins with /. Default: /'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 62
  
  property :request_uri, description: 'The URI to use for HTTP health check request.
  Range of values: URI (virtual directory) that begins with /.
  Default: /', set_prop: true, type: String

• #response_code_match ⇒ String
  'A modified regular expression to specify what response status codes are acceptable for a healthy origin server. The expression is a union of 3-character patterns that contain only digits or x, where x stands for any digit. For example, the following 3 expressions are valid: 200, 2xx or 304, 1xx or 2xx or 3xx or 4xx. If the parameter is not specified, all codes except 5xx server errors are considered acceptable.'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 66
  
  property :response_code_match, description: 'A modified regular expression to specify what response status codes are acceptable for a healthy origin server. The expression is a union of 3-character patterns that contain only digits or x, where x stands for any digit. For example, the following 3 expressions are valid: 200, 2xx or 304, 1xx or 2xx or 3xx or 4xx. If the parameter is not specified, all codes except 5xx server errors are considered acceptable.', set_prop: true, type: String

• #response_body_match ⇒ String
  'A regular expression used to match the HTTP response body in order to determine if the server is healthy. The origin server will be marked UP if the ping response matches the regular expression (if this parameter is specified) and the response status code is not a 5xx server error (if this parameter is not specified). If response body match is enabled, request method should be set to GET.'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 68
  
  property :response_body_match, description: 'A regular expression used to match the HTTP response body in order to determine if the server is healthy. The origin server will be marked UP if the ping response matches the regular expression (if this parameter is specified) and the response status code is not a 5xx server error (if this parameter is not specified). If response body match is enabled, request method should be set to GET.', set_prop: true, type: String

• #response_body_match_size ⇒ Integer
  'The maximum length of response body to be matched. Range of values: size in bytes between 0 and 2147483647, inclusive. Default: 2048.'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 72
  
  property :response_body_match_size, description: 'The maximum length of response body to be matched.
  Range of values: size in bytes between 0 and 2147483647, inclusive.
  Default: 2048.', set_prop: true, type: Integer

• #dynamic_server_discovery ⇒ [TrueClass, FalseClass]
  'Indicates whether the server caches the file content. Range of values: true or false. Default: false.'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 78
  
  property :dynamic_server_discovery, description: 'Indicates whether the server caches the file content.
  Range of values: true or false.
  Default: false.', set_prop: true, type: [TrueClass, FalseClass]

• #command ⇒ String
  'The full path of the external health check executable.'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 82
  
  property :command, description: 'The full path of the external health check executable.', set_prop: true, type: String

• #use_object_file ⇒ [TrueClass, FalseClass]
  'Indicates whether object file processing is done for health-check-requests. Range of values: true or false. Default: true.'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 86
  
  property :use_object_file, description: 'Indicates whether object file processing is done for health-check-requests.
  Range of values: true or false.
  Default: true.', set_prop: true, type: [TrueClass, FalseClass]

• #configuration ⇒ [MintPress::OracleTrafficDirector::Configuration] (Default Value: Proc.new { origin_server_pool.configuration })
  'Name of the configuration.'
  Property Attributes
  • set_prop ⇒ true
  • from ⇒ String
  • default ⇒ Proc.new { origin_server_pool.configuration }

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 90
  
  property :configuration, description: 'Name of the configuration.', set_prop: true, type: [MintPress::OracleTrafficDirector::Configuration], from: String, default: Proc.new { origin_server_pool.configuration }

• #origin_server_pool ⇒ [MintPress::OracleTrafficDirector::OriginServerPool]
  'Name of the origin server pool.'
  Property Attributes
  • set_prop ⇒ true
  • from ⇒ String

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 92
  
  property :origin_server_pool, description: 'Name of the origin server pool.', set_prop: true, type: [MintPress::OracleTrafficDirector::OriginServerPool], from: String

• #parent ⇒ MintPress::OracleTrafficDirector::OriginServerPool
  
  Property Attributes

  # File 'src/oracle-otd/lib/oracle-otd/generated/health_check.rb', line 93
  
  property :parent, type: MintPress::OracleTrafficDirector::OriginServerPool

Properties (Read Only)

Constant Summary

MODEL_PARENTS =

["configuration", "origin-server-pool"]

LIST_PARAMS =

nil

GET_PARAMS =

["configuration", "origin-server-pool"]

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

• #get_params ⇒ Object
  Returns the value of attribute get_params.
• #list_params ⇒ Object
  Returns the value of attribute list_params.
• #model_parents ⇒ Object
  Returns the value of attribute model_parents.

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Attributes included from OtdCommon

#harvested

Instance Method Summary

• #create ⇒ Object
• #destroy ⇒ Object
• #exist? ⇒ Boolean
• #initialize(opts = {}) ⇒ HealthCheck constructor
  A new instance of HealthCheck.

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Methods included from OtdCommon

#can_exist?, #creator_available?, #delete_generic, #delete_props, #destroy_generic, #disable_props, #empty_mbean?, #enable_prop_generic, #enable_props, #exist_generic?, #form_props, #get_domain, #get_property_from_target, #get_props, #handle_type, #harvest, #harvesters, #harvesting, #list_generic, #list_props, #otd_create_generic, #otd_propize, #set_prop_generic, #set_props

Constructor Details

#initialize(opts = {}) ⇒ HealthCheck

Returns a new instance of HealthCheck.

Instance Attribute Details

#get_params ⇒ Object

Returns the value of attribute get_params.

#list_params ⇒ Object

Returns the value of attribute list_params.

#model_parents ⇒ Object

Returns the value of attribute model_parents.

Instance Method Details

#create ⇒ Object

#destroy ⇒ Object

#exist? ⇒ Boolean

Returns:

• (Boolean)