Class: MintPress::OracleTrafficDirector::RouteBandwidthLimit

Inherits:
Object
  • Object
show all
Includes:
MintLogger, Mixins::Properties, OtdCommon
Defined in:
src/oracle-otd/lib/oracle-otd/generated/route_bandwidth_limit.rb

Overview

enable bandwidth limiting at the route level.

Properties (Read/Write)

  • #name ⇒ String

    Property Attributes 
    

27
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route_bandwidth_limit.rb', line 27

property :name, type: String
  • #configuration ⇒ [MintPress::OracleTrafficDirector::Configuration] (Default Value: Proc.new { virtual_server.configuration })
    'Name of the configuration.'
    Property Attributes
    • disable_prop ⇒ true
    • from ⇒ String
    • enable_prop ⇒ true
    • default ⇒ Proc.new { virtual_server.configuration }
    

30
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route_bandwidth_limit.rb', line 30

property :configuration, description: 'Name of the configuration.', disable_prop: true, type: [MintPress::OracleTrafficDirector::Configuration], from: String, enable_prop: true, default: Proc.new { virtual_server.configuration }
  • #virtual_server ⇒ [MintPress::OracleTrafficDirector::VirtualServer] (Default Value: Proc.new { route.virtual_server })
    'Name of the virtual server for which bandwidth limit is to be enabled.'
    Property Attributes
    • disable_prop ⇒ true
    • from ⇒ String
    • enable_prop ⇒ true
    • default ⇒ Proc.new { route.virtual_server }
    

32
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route_bandwidth_limit.rb', line 32

property :virtual_server, description: 'Name of the virtual server for which bandwidth limit is to be enabled.', disable_prop: true, type: [MintPress::OracleTrafficDirector::VirtualServer], from: String, enable_prop: true, default: Proc.new { route.virtual_server }
  • #route ⇒ [MintPress::OracleTrafficDirector::Route]
    'Name of the route for which bandwidth limit is to be enabled.'
    Property Attributes
    • disable_prop ⇒ true
    • from ⇒ String
    • enable_prop ⇒ true
    

34
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route_bandwidth_limit.rb', line 34

property :route, description: 'Name of the route for which bandwidth limit is to be enabled.', disable_prop: true, type: [MintPress::OracleTrafficDirector::Route], from: String, enable_prop: true
  • #type ⇒ String
    'Type of bandwidth limiting is to be applied. Range of values: request or response.'
    Property Attributes
    • disable_prop ⇒ true
    • enable_prop ⇒ true
    

37
38
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route_bandwidth_limit.rb', line 37

property :type, description: 'Type of bandwidth limiting is to be applied.
Range of values: request or response.', disable_prop: true, type: String, enable_prop: true
  • #enabled ⇒ [TrueClass, FalseClass]
    'Enable RouteBandwidthLimit?'
    Property Attributes 
    

40
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route_bandwidth_limit.rb', line 40

property :enabled, type: [TrueClass, FalseClass], description: 'Enable RouteBandwidthLimit?'
  • #max_bps_per_monitor ⇒ String
    'Value in bytes/sec for maximum request bandwidth for the entire bucket. Default: 0.'
    Property Attributes
    • enable_prop ⇒ true
    

43
44
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route_bandwidth_limit.rb', line 43

property :max_bps_per_monitor, description: 'Value in bytes/sec for maximum request bandwidth for the entire bucket.
Default: 0.', enable_prop: true, type: String
  • #max_bps_per_connection ⇒ String
    'Value in bytes/sec for maximum request bandwidth per connection. Default: 0.'
    Property Attributes
    • enable_prop ⇒ true
    

47
48
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route_bandwidth_limit.rb', line 47

property :max_bps_per_connection, description: 'Value in bytes/sec for maximum request bandwidth per connection.
Default: 0.', enable_prop: true, type: String
  • #timeout ⇒ String
    'Value in second. Request is aborted when it had to wait in the queue for this much time. Default: 60.'
    Property Attributes
    • enable_prop ⇒ true
    

51
52
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route_bandwidth_limit.rb', line 51

property :timeout, description: 'Value in second. Request is aborted when it had to wait in the queue for this much time.
Default: 60.', enable_prop: true, type: String
  • #monitor ⇒ String
    'Name of bucket to which the request belongs to. Default: $ip if type is "response".'
    Property Attributes
    • enable_prop ⇒ true
    

55
56
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route_bandwidth_limit.rb', line 55

property :monitor, description: 'Name of bucket to which the request belongs to.
Default: $ip if type is "response".', enable_prop: true, type: String
  • #error_code ⇒ String
    'HTTP error code that is returned when request is aborted. Range of value: 400-599. Default: 503.'
    Property Attributes
    • enable_prop ⇒ true
    

60
61
62
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route_bandwidth_limit.rb', line 60

property :error_code, description: 'HTTP error code that is returned when request is aborted.
Range of value: 400-599.
Default: 503.', enable_prop: true, type: String

Properties (Read Only)

Constant Summary collapse

MODEL_PARENTS = 
["configuration", "virtual-server", "route", "type"]
LIST_PARAMS = 
nil
GET_PARAMS = 
["configuration", "virtual-server", "route", "type"]

Constants included from MintLogger

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

Instance Attribute Summary collapse

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 collapse

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 = {}) ⇒ RouteBandwidthLimit

Returns a new instance of RouteBandwidthLimit.

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)