Java API for Building Cube

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

Build a cube object

1. Build cube with NOW option

2. Build cube with ONCE option

3. Cancel cube build if currently running

4. Resume cube build

5. Replace partitions

6. Data profile for Cube with ONCE option

7. Data profile for Cube with NOW option

Examples

1. Build cube with NOW option

   /** * method to build Cube Object * @param cubeName: name of the cube * @param folderName: name of the folder containing cube * @param buildType: type of the build , FULL or INCREMENTAL * @param additionalParams: JSONObject containing fields: userParams, replacePartition, consolidationType, buildSourceDatasets, * recommendationParamsJson, minimalAggregation, minimalAggregation, factDataPartitionSize, * factDataPartitionCount, incrementalJobProcessType * factDataPartitionCount, incrementalJobProcessType, buildConnectionName */ public void buildCubeNow(String cubeName, String folderName, String buildType, UserInfo userInfo, JSONObject additionalParams);

2. Build cube with ONCE option

   /** * method to build Cube Object * @param cubeName: name of the cube * @param folderName: name of the folder containing cube * @param buildType: type of the build , FULL or INCREMENTAL * @param additionalParams: JSONObject containing fields: userParams, onceDateTime, replacePartition, consolidationType, buildSourceDatasets, * recommendationParamsJson, minimalAggregation, minimalAggregation, factDataPartitionSize, * factDataPartitionCount, incrementalJobProcessType, buildConnectionName */ public void buildCubeOnce(String cubeName, String folderName, String buildType, UserInfo userInfo, JSONObject additionalParams);

3. Cancel cube build if currently running.

   /** * Method to add ONCE build schedule for cube object * @param cubeName: name of the cube * @param folderName: name of the folder containing cube * @param buildType: type of the build, FULL or INCREMENTAL * @param onceDateTime: date time in format mm/dd/yyyy hh:mm * @param userInfo: Object of type UserInfo containing information about logged in user * @param incrementalJobProcessType: type of process: FACT_ADJUSTMENTS */ public void buildCubeOnce(String cubeName, String folderName, String buildType, String onceDateTime, UserInfo userInfo, String incrementalJobProcessType);

4. Resume cube build

5. Replace partitions.

6. Data profile for a cube with ONCE option

7. Data profile for a cube with NOW option.

8. Parse connectionXML and set internal properties of DBConnection. 

9. Set a property in a DBConnection object.

10. Set a property in a DBConnection. It is useful when a value is encrypted.

Sample code