Document toolboxDocument toolbox

Java API for Cache Auto-population

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)


Overview

  1. Cache Build.

    Build cache with NOW option

    Build cache with ONCE option

  2. Cache Rules.

    Add Rules

    Delete Rules

    Update Rules

Example

  1. Cache Build.

    1. Build cache with NOW option

      /** * method to build cache in Scheduler Manager. * @param cubeName: Name of the cube. * @param folderName: Name of the folder containing cube, use “” for root folder. * @param userInfo: Object of type UserInfo containing information about logged in user. */ public void buildCubeCacheNow(cubeName, folderName, userinfo);
      1. Build cache with ONCE option

        /** * method to add ONCE build schedule for cache in Scheduler Manager. * @param cubeName: Name of the cube. * @param folderName: Name of the folder containing cube, use “” for root folder. * @param onceDateTime: Date time in format mm/dd/yyyy hh:mm. * @param userInfo: Object of type UserInfo containing information about logged in user. */ public void buildCubeCacheOnce(cubeName, folderName, onceDateTime, userinfo);
  2. Cache Rules.

    1. Add Rules

      /** * method to add rules in cache build. * @param cubeName: Name of the cube. * @param folderName: Name of the folder containing cube, use “” for root folder. * third parameter in method "addCachePopulationRules" is boolean which is to specify whether to build cache on cube build. * @param filters: Object of type Filters containing filter which needs to be added in cache rules. * @param userInfo: Object of type UserInfo containing information about logged in user. */ public List<ResponseStatus> addCachePopulationRules(cubeName, folderName, true, filters, userInfo); 
    2. Delete Rules

    3. Update Rules

Sample Code

Copyright Kyvos, Inc. All rights reserved.