Class: MintPress::OracleTrafficDirector::Cache

Inherits:

Object

• Object
• MintPress::OracleTrafficDirector::Cache

Includes:

MintLogger, Mixins::Properties, OtdCommon

Defined in:

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

Overview

define or change the following caching properties for a configuration:

Properties (Read/Write)

• #name ⇒ String
  
  Property Attributes

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

• #enabled ⇒ [TrueClass, FalseClass]
  'Defines if caching is enabled or not. Range of values: true or false. Default: true.'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/cache.rb', line 32
  
  property :enabled, description: 'Defines if caching is enabled or not.
  Range of values: true or false.
  Default: true.', set_prop: true, type: [TrueClass, FalseClass]

• #max_entries ⇒ Integer
  'Maximum number of objects for which to cache content. Range of values: 1 - 1073741824. Default: 1024.'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/cache.rb', line 38
  
  property :max_entries, description: 'Maximum number of objects for which to cache content.
  Range of values: 1 - 1073741824.
  Default: 1024.', set_prop: true, type: Integer

• #replacement ⇒ String
  'Cache entry replacement algorithm. Range of values: lru, lfu, or false. Default: lru.'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/cache.rb', line 44
  
  property :replacement, description: 'Cache entry replacement algorithm.
  Range of values: lru, lfu, or false.
  Default: lru.', set_prop: true, type: String

• #max_heap_object_size ⇒ Integer
  'Maximum size of response (single entry) (in bytes) to cache on the heap. If HTTP response object is bigger than max-heap-object-size, it will not be cached. Range of values: maximum size in bytes between 0 and 2147483647, inclusive. -1 indicates that there is no maximum size. Default: 524288.'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/cache.rb', line 50
  
  property :max_heap_object_size, description: 'Maximum size of response (single entry) (in bytes) to cache on the heap. If HTTP response object is bigger than max-heap-object-size, it will not be cached.
  Range of values: maximum size in bytes between 0 and 2147483647, inclusive. -1 indicates that there is no maximum size.
  Default: 524288.', set_prop: true, type: Integer

• #max_heap_size ⇒ Integer
  'Maximum amount (in bytes) of heap to use for caching response objects. It should not be more than available memory or process address space. Range of values: maximum amount of address space in bytes between 0 and 1099511627776, inclusive. Default: 10485760.'
  Property Attributes
  • set_prop ⇒ true

  # File 'src/oracle-otd/lib/oracle-otd/generated/cache.rb', line 56
  
  property :max_heap_size, description: 'Maximum amount (in bytes) of heap to use for caching response objects. It should not be more than available memory or process address space.
  Range of values: maximum amount of address space in bytes between 0 and 1099511627776, inclusive.
  Default: 10485760.', set_prop: true, type: Integer

• #configuration ⇒ [MintPress::OracleTrafficDirector::Configuration]
  'Name of the configuration.'
  Property Attributes
  • set_prop ⇒ true
  • from ⇒ String

  # File 'src/oracle-otd/lib/oracle-otd/generated/cache.rb', line 60
  
  property :configuration, description: 'Name of the configuration.', set_prop: true, type: [MintPress::OracleTrafficDirector::Configuration], from: String

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

  # File 'src/oracle-otd/lib/oracle-otd/generated/cache.rb', line 61
  
  property :parent, type: MintPress::OracleTrafficDirector::Configuration

Properties (Read Only)

Constant Summary

MODEL_PARENTS =

["configuration"]

LIST_PARAMS =

nil

GET_PARAMS =

["configuration"]

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 = {}) ⇒ Cache constructor
  A new instance of Cache.

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

Returns a new instance of Cache.

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)