Class: IControl::LocalLB::RAMCacheInformation

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/local_lb/ram_cache_information.rb,
lib/icontrol/local_lb.rb

Overview

The RAMCacheInformation interface enables you to query for RAM cache entries/statistics, as well as evicting RAM cache entries.

Defined Under Namespace

Classes: RAMCacheEntry, RAMCacheEntryExactMatch, RAMCacheEntryExactMatchSequence, RAMCacheEntryExactMatchSequenceSequence, RAMCacheEntrySequence, RAMCacheEntrySequenceSequence, RAMCacheKey, RAMCacheKeySequence, RAMCacheVaryType, RAMCacheVaryTypeSequence

Instance Method Summary (collapse)

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

- (Object) evict_all_ramcache_entries

Resets/evicts all cache entries.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



25
26
27
# File 'lib/icontrol/local_lb/ram_cache_information.rb', line 25

def evict_all_ramcache_entries
  super
end

- (Object) evict_ramcache_entry

Note: This function has been deprecated. Please use evict_ramcache_entry_v2. Resets/evicts the cache entries associated with this key. Note: The "max_responses" field in each RAMCacheKey key is ignored in this method.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



37
38
39
# File 'lib/icontrol/local_lb/ram_cache_information.rb', line 37

def evict_ramcache_entry
  super
end

- (Object) evict_ramcache_entry_v2(opts)

Resets/evicts the cache entries associated with this key. Note: The "max_responses" field in each RAMCacheKey key is ignored in this method.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :exact_match (boolean)

    Whether to look for an exact match for host and uri. If exact, you must specify host and uri in the key. If non-exact, host and uri can be a subset of the text in a matched entry during the search.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



50
51
52
53
# File 'lib/icontrol/local_lb/ram_cache_information.rb', line 50

def evict_ramcache_entry_v2(opts)
  check_params(opts,[:exact_match])
  super
end

- (RAMCacheEntry[]) ramcache_entry

Gets the RAM cache entries associated with this key. The "profile_name" in the key is required, however, other fields in each key are optionally specified. "max_response" is recommended to be set to avoid possible large amount of entries.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



65
66
67
# File 'lib/icontrol/local_lb/ram_cache_information.rb', line 65

def ramcache_entry
  super
end

- (RAMCacheEntryExactMatch[]) ramcache_entry_exact_match

Gets the RAM cache entries associated with this key. Each field in the key must be provided, and together the key is used to extract a specific entry. However, since each entry with the same profile/hostname/URI can still vary based on the User-Agent or Accept-Encoding headers, a separate entry will be returned for each variation, with also the specific header string that causes the variation.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



80
81
82
# File 'lib/icontrol/local_lb/ram_cache_information.rb', line 80

def ramcache_entry_exact_match
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


88
89
90
# File 'lib/icontrol/local_lb/ram_cache_information.rb', line 88

def version
  super
end