com.splunk

Class DataModel

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.DataModel

All Implemented Interfaces:

Map<String,Object>

public class DataModel
extends Entity

DataModel represents a data model on the server. Data models contain data model objects, which specify structured views on Splunk data.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.splunk.Entity

content, toUpdate

Fields inherited from class com.splunk.Resource

actions, path, refreshArgs, service, title, updated

Method Summary

Modifier and Type	Method and Description
boolean	containsObject(String name) Returns whether there is an object of the given name in this data model.
String	getAccelerationCronSchedule() Return the cron schedule on which the cached data for acceleration should be updated.
String	getAccelerationNamespace() Returns the tsidx namespace which holds global acceleration events for this data model.
String	getDescription()
String	getDisplayName()
String	getEarliestAcceleratedTime() Return the earliest time of the window over which the data model is accelerated.
DataModelObject	getObject(String name) Retrieve an object by name from this data model.
Collection<DataModelObject>	getObjects()
String	getRawJson()
boolean	isAccelerated()
boolean	isManualRebuilds() This setting prevents outdated summaries from being rebuilt by the 'summarize' command.
void	setAcceleration(boolean enabled) Enable or disable global acceleration on this data model.
void	setAccelerationCronSchedule(String accelerationCronSchedule) Set the cron schedule on which the cached data for the acceleration should be updated.
void	setEarliestAcceleratedTime(String earliestAcceleratedTime) Set the size of the window (from the specified earliest time to now) over which the data model should be accelerated.
void	setManualRebuilds(boolean enabled) Enable or disable manual rebuilds on this data model.
void	update() Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.

Methods inherited from class com.splunk.Entity

actionPath, clear, containsKey, containsValue, disable, enable, entrySet, get, getContent, getMetadata, isDisabled, isEmpty, isNameChangeAllowed, keySet, put, putAll, refresh, remove, remove, size, update, validate, values

Methods inherited from class com.splunk.Resource

getName, getPath, getService, getTitle, getUpdated, invalidate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Detail

containsObject

public boolean containsObject(String name)

Returns whether there is an object of the given name in this data model.

Parameters:

name - Name of the object to check for.

Returns:

true if there is an object with that name; false otherwise.

getObject

public DataModelObject getObject(String name)

Retrieve an object by name from this data model.

Parameters:

name - Name of the object to retrieve.

Returns:

a DataModelObject if there is such an object; null otherwise.

getObjects

public Collection<DataModelObject> getObjects()

Returns:

a collection of all objects in this data model.

getAccelerationNamespace

public String getAccelerationNamespace()

Returns the tsidx namespace which holds global acceleration events for this data model. The namespace will be returned whether acceleration is enabled or not.

Returns:

The tsidx namespace for global acceleration of this data model.

isAccelerated

public boolean isAccelerated()

Returns:

whether global acceleration is enabled for this data model.

getDescription

public String getDescription()

Returns:

A human readable description of this data model.

getRawJson

public String getRawJson()

Returns:

The raw JSON describing this data model and its objects.

getDisplayName

public String getDisplayName()

Returns:

the human readable name of this data model.

setAcceleration

public void setAcceleration(boolean enabled)

Enable or disable global acceleration on this data model.

Parameters:

enabled - true enabled, false disables.

getEarliestAcceleratedTime

public String getEarliestAcceleratedTime()

Return the earliest time of the window over which the data model is accelerated. Times are represented relative to now, given by a minus sign, a number, and a suffix indicating the time unit (e.g., "-2mon", "-1day").

Returns:

a string representing the earliest accelerated time.

setEarliestAcceleratedTime

public void setEarliestAcceleratedTime(String earliestAcceleratedTime)

Set the size of the window (from the specified earliest time to now) over which the data model should be accelerated. Times are represented relative to now, given by a minus sign, a number, and a suffix indicating the time unit (e.g., "-2mon", "-1day").

Parameters:

earliestAcceleratedTime - a string specifying a time.

getAccelerationCronSchedule

public String getAccelerationCronSchedule()

Return the cron schedule on which the cached data for acceleration should be updated.

Returns:

a string containing a crontab style schedule specification.

setAccelerationCronSchedule

public void setAccelerationCronSchedule(String accelerationCronSchedule)

Set the cron schedule on which the cached data for the acceleration should be updated.

Parameters:

accelerationCronSchedule - a crontab style schedule to use.

isManualRebuilds

public boolean isManualRebuilds()

This setting prevents outdated summaries from being rebuilt by the 'summarize' command.

Returns:

whether manual rebuilds are enabled for this data model.

setManualRebuilds

public void setManualRebuilds(boolean enabled)

Enable or disable manual rebuilds on this data model.

Parameters:

enabled - true enabled, false disables.

update

public void update()

Description copied from class: Entity

Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.

Overrides:

update in class Entity