Package io.revealbi.core.data

Class RVElasticsearchDataSourceItem

java.lang.Object

io.revealbi.core.data.RVDataSourceItem

io.revealbi.core.data.RVElasticsearchDataSourceItem

All Implemented Interfaces:

IProcessDataOnServerDataSourceItem

public class RVElasticsearchDataSourceItem
extends RVDataSourceItem
implements IProcessDataOnServerDataSourceItem

Elasticsearch data source item

Constructor Summary

Constructors

Constructor	Description
RVElasticsearchDataSourceItem(RVElasticsearchDataSource dataSource)

Method Summary

Modifier and Type	Method	Description
String	getCustomQuery()	(Optional) Custom Elasticsearch SQL query to execute instead of using the default index query.
Boolean	getFieldMultiValueLeniency()	(Optional) Controls behavior when SQL queries encounter fields with multiple values.
String	getIndex()	The name of the Elasticsearch index to query.
boolean	getProcessDataOnServer()	Returns whether data processing is performed on the Reveal server.
void	setCustomQuery(String customQuery)	(Optional) Custom Elasticsearch SQL query to execute instead of using the default index query.
void	setFieldMultiValueLeniency(Boolean fieldMultiValueLeniency)	(Optional) Controls behavior when SQL queries encounter fields with multiple values.
void	setIndex(String index)	The name of the Elasticsearch index to query.
void	setProcessDataOnServer(boolean processDataOnServer)	Sets whether data processing is performed on the Reveal server.

Methods inherited from class io.revealbi.core.data.RVDataSourceItem

getDataSource, getDefaultRefreshRate, getDescription, getId, getSubtitle, getTitle, setDataSource, setDefaultRefreshRate, setDescription, setId, setSubtitle, setTitle

Methods inherited from class java.lang.Object

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

Constructor Details

RVElasticsearchDataSourceItem

public RVElasticsearchDataSourceItem(RVElasticsearchDataSource dataSource)

Method Details

getIndex

public String getIndex()

The name of the Elasticsearch index to query.

Returns:

The name of the Elasticsearch index to query.

setIndex

public void setIndex(String index)

The name of the Elasticsearch index to query.

Parameters:

index - The name of the Elasticsearch index to query.

getFieldMultiValueLeniency

public Boolean getFieldMultiValueLeniency()

(Optional) Controls behavior when SQL queries encounter fields with multiple values. If false, an error is returned for fields containing array values. If true, returns the first value from the array with no guarantee of consistent ordering. Defaults to false.

Returns:

(Optional) Controls behavior when SQL queries encounter fields with multiple values. If false, an error is returned for fields containing array values. If true, returns the first value from the array with no guarantee of consistent ordering. Defaults to false.

setFieldMultiValueLeniency

public void setFieldMultiValueLeniency(Boolean fieldMultiValueLeniency)

(Optional) Controls behavior when SQL queries encounter fields with multiple values. If false, an error is returned for fields containing array values. If true, returns the first value from the array with no guarantee of consistent ordering. Defaults to false.

Parameters:

fieldMultiValueLeniency - (Optional) Controls behavior when SQL queries encounter fields with multiple values. If false, an error is returned for fields containing array values. If true, returns the first value from the array with no guarantee of consistent ordering. Defaults to false.

getCustomQuery

public String getCustomQuery()

(Optional) Custom Elasticsearch SQL query to execute instead of using the default index query.

Returns:

(Optional) Custom Elasticsearch SQL query to execute instead of using the default index query.

setCustomQuery

public void setCustomQuery(String customQuery)

(Optional) Custom Elasticsearch SQL query to execute instead of using the default index query.

Parameters:

customQuery - (Optional) Custom Elasticsearch SQL query to execute instead of using the default index query.

getProcessDataOnServer

public boolean getProcessDataOnServer()

Returns whether data processing is performed on the Reveal server.

Specified by:

getProcessDataOnServer in interface IProcessDataOnServerDataSourceItem

Returns:

Returns whether data processing is performed on the Reveal server.

setProcessDataOnServer

public void setProcessDataOnServer(boolean processDataOnServer)

Sets whether data processing is performed on the Reveal server.

Specified by:

setProcessDataOnServer in interface IProcessDataOnServerDataSourceItem

Parameters:

processDataOnServer - Whether data processing is performed on the Reveal server.