Class: MintPress::OracleTrafficDirector::CacheRule

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

Overview

set the following cache rule properties:

Properties (Read/Write)

  • #name ⇒ String

    Property Attributes 
    

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

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

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

property :configuration, description: 'Name of the configuration.', otd_prop: true, otd_mandatory: true, type: [MintPress::OracleTrafficDirector::Configuration], from: String, delete_prop: true, otd_delete_mandatory: true, set_prop: true, default: Proc.new { virtual_server.configuration }
  • #virtual_server ⇒ [MintPress::OracleTrafficDirector::VirtualServer]
    'Name of the virtual server.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • from ⇒ String
    • delete_prop ⇒ true
    • otd_delete_mandatory ⇒ true
    • set_prop ⇒ true
    

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

property :virtual_server, description: 'Name of the virtual server.', otd_prop: true, otd_mandatory: true, type: [MintPress::OracleTrafficDirector::VirtualServer], from: String, delete_prop: true, otd_delete_mandatory: true, set_prop: true
  • #cache_rule ⇒ String (Default Value: Proc.new { self.name })
    'Name of the cache rule.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • default ⇒ Proc.new { self.name }
    • delete_prop ⇒ true
    • otd_delete_mandatory ⇒ true
    • set_prop ⇒ true
    

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

property :cache_rule, description: 'Name of the cache rule.', otd_prop: true, otd_mandatory: true, type: String, default: Proc.new { self.name }, delete_prop: true, otd_delete_mandatory: true, set_prop: true
  • #condition ⇒ String
    'A condition is an expression which if evaluates to true, will result in the rule being executed. Conditions are constructed from literals, variables, functions and operators.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • set_prop ⇒ true
    

36
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/cache_rule.rb', line 36

property :condition, description: 'A condition is an expression which if evaluates to true, will result in the rule being executed. Conditions are constructed from literals, variables, functions and operators.', otd_prop: true, otd_mandatory: true, type: String, set_prop: true
  • #enabled ⇒ String
    'Specifies whether the caching rule is enabled.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :enabled, description: 'Specifies whether the caching rule is enabled.', set_prop: true, type: String
  • #max_reload_interval ⇒ Integer
    'Specifies the maximum time (in seconds) allowed between consecutive up-to-date checks. Range of values: any positive Integer. Default: 3600.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :max_reload_interval, description: 'Specifies the maximum time (in seconds) allowed between consecutive up-to-date checks.
Range of values: any positive Integer.
Default: 3600.', set_prop: true, type: Integer
  • #min_reload_time ⇒ Integer
    'Specifies the minimum time (in seconds) allowed between consecutive up-to-date checks of a cached document. Range of values: any positive Integer. Default: 0.'
    Property Attributes
    • set_prop ⇒ true
    

48
49
50
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/cache_rule.rb', line 48

property :min_reload_time, description: 'Specifies the minimum time (in seconds) allowed between consecutive up-to-date checks of a cached document.
Range of values: any positive Integer.
Default: 0.', set_prop: true, type: Integer
  • #last_modified_factor ⇒ Float
    'Represents the factor used in estimating the expiry time, which defines how long a document will be up-to-date based on time it was last modified. This property is used only when the explicit age of the document is not available. Range of values: any positive Integer. Default: 0.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :last_modified_factor, description: 'Represents the factor used in estimating the expiry time, which defines how long a document will be up-to-date based on time it was last modified. This property is used only when the explicit age of the document is not available.
Range of values: any positive Integer.
Default: 0.', set_prop: true, type: Float
  • #min_object_size ⇒ Integer
    'The maximum size, in bytes, of any document to be cached. This setting enables users to limit the maximum size of cached documents, so that no single document can take too much space. This value cannot exceed the value of max-heap-object-size. Range of values: any positive Integer. Default: 0.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :min_object_size, description: 'The maximum size, in bytes, of any document to be cached. This setting enables users to limit the maximum size of cached documents, so that no single document can take too much space. This value cannot exceed the value of max-heap-object-size.
Range of values: any positive Integer.
Default: 0.', set_prop: true, type: Integer
  • #max_object_size ⇒ Integer
    'Specifies the minimum size (in bytes) of any document to be cached. Range of values: any positive Integer.'
    Property Attributes
    • set_prop ⇒ true
    

65
66
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/cache_rule.rb', line 65

property :max_object_size, description: 'Specifies the minimum size (in bytes) of any document to be cached.
Range of values: any positive Integer.', set_prop: true, type: Integer
  • #query_maxlen ⇒ Integer
    'Specifies the number of characters in the query string. If this property is set to 0, URIs with query strings are not cached. Range of values: any positive Integer. Default: 0.'
    Property Attributes
    • set_prop ⇒ true
    

70
71
72
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/cache_rule.rb', line 70

property :query_maxlen, description: 'Specifies the number of characters in the query string. If this property is set to 0, URIs with query strings are not cached.
Range of values: any positive Integer.
Default: 0.', set_prop: true, type: Integer
  • #compression ⇒ [TrueClass, FalseClass]
    'If this property value is set to true, the document is compressed before storing in the cache Range of values: true or false. Default: false.'
    Property Attributes
    • set_prop ⇒ true
    

76
77
78
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/cache_rule.rb', line 76

property :compression, description: 'If this property value is set to true, the document is compressed before storing in the cache
Range of values: true or false.
Default: false.', set_prop: true, type: [TrueClass, FalseClass]
  • #cache_https_response ⇒ [TrueClass, FalseClass]
    'If this property value is set to true, responses from the HTTPS servers are also cached. Range of values: true or false. Default: false.'
    Property Attributes
    • set_prop ⇒ true
    

82
83
84
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/cache_rule.rb', line 82

property :cache_https_response, description: 'If this property value is set to true, responses from the HTTPS servers are also cached.
Range of values: true or false.
Default: false.', set_prop: true, type: [TrueClass, FalseClass]
  • #parent ⇒ MintPress::OracleTrafficDirector::VirtualServer

    Property Attributes 
    

85
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/cache_rule.rb', line 85

property :parent, type: MintPress::OracleTrafficDirector::VirtualServer

Properties (Read Only)

Constant Summary collapse

MODEL_PARENTS = 
["configuration", "virtual-server"]
LIST_PARAMS = 
["configuration", "virtual-server"]
GET_PARAMS = 
["configuration", "virtual-server", "cache-rule"]

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

Returns a new instance of CacheRule.

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)