ch.postfinance.sdk.model

Class AnalyticsQuery

java.lang.Object

ch.postfinance.sdk.model.AnalyticsQuery

public class AnalyticsQuery
extends Object

Represents a query to be submitted for execution in Analytics.

Field Summary

Fields

Modifier and Type	Field and Description
protected Long	accountId
protected String	externalId
protected Integer	maxCacheAge
protected String	queryString
protected BigDecimal	scannedDataLimit
protected List<Long>	spaceIds

Constructor Summary

Constructors

Constructor and Description
AnalyticsQuery()

Method Summary

Modifier and Type	Method and Description
AnalyticsQuery	accountId(Long accountId)
AnalyticsQuery	addSpaceIdsItem(Long spaceIdsItem)
boolean	equals(Object o)
AnalyticsQuery	externalId(String externalId)
Long	getAccountId() The mandatory ID of an account in which the query shall be executed.
String	getExternalId() A client generated nonce which uniquely identifies the query to be executed.
Integer	getMaxCacheAge() The maximal age in minutes of cached query executions to return.
String	getQueryString() The SQL statement which is being submitted for execution.
BigDecimal	getScannedDataLimit() The maximal amount of scanned data that this query is allowed to scan.
List<Long>	getSpaceIds() The IDs of the spaces in which the query shall be executed.
int	hashCode()
AnalyticsQuery	maxCacheAge(Integer maxCacheAge)
AnalyticsQuery	queryString(String queryString)
AnalyticsQuery	scannedDataLimit(BigDecimal scannedDataLimit)
void	setAccountId(Long accountId)
void	setExternalId(String externalId)
void	setMaxCacheAge(Integer maxCacheAge)
void	setQueryString(String queryString)
void	setScannedDataLimit(BigDecimal scannedDataLimit)
void	setSpaceIds(List<Long> spaceIds)
AnalyticsQuery	spaceIds(List<Long> spaceIds)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

accountId

protected Long accountId

externalId

protected String externalId

maxCacheAge

protected Integer maxCacheAge

queryString

protected String queryString

scannedDataLimit

protected BigDecimal scannedDataLimit

spaceIds

protected List<Long> spaceIds

Constructor Detail

AnalyticsQuery

public AnalyticsQuery()

Method Detail

accountId

public AnalyticsQuery accountId(Long accountId)

getAccountId

public Long getAccountId()

The mandatory ID of an account in which the query shall be executed. Must be a valid account ID greater than 0.

Returns:

accountId

setAccountId

public void setAccountId(Long accountId)

externalId

public AnalyticsQuery externalId(String externalId)

getExternalId

public String getExternalId()

A client generated nonce which uniquely identifies the query to be executed. Subsequent submissions with the same external ID will not re-execute the query but instead return the existing execution with that ID. Either the External ID or a Maximal Cache Age greater than 0 must be specified. If both are specified the External ID will have precedence and the Maximal Cache Age will be ignored.

Returns:

externalId

setExternalId

public void setExternalId(String externalId)

maxCacheAge

public AnalyticsQuery maxCacheAge(Integer maxCacheAge)

getMaxCacheAge

public Integer getMaxCacheAge()

The maximal age in minutes of cached query executions to return. If an equivalent query execution with the same Query String, Account ID and Spaces parameters not older than the specified age is already available that execution will be returned instead of a newly started execution. Set to 0 or null (and set a unique, previously unused External ID) to force a new query execution irrespective of previous executions. Either the External ID or a Cache Duration greater than 0 must be specified. If both are specified, the External ID will be preferred (and the Maximal Cache Age ignored).

Returns:

maxCacheAge

setMaxCacheAge

public void setMaxCacheAge(Integer maxCacheAge)

queryString

public AnalyticsQuery queryString(String queryString)

getQueryString

public String getQueryString()

The SQL statement which is being submitted for execution. Must be a valid PrestoDB/Athena SQL statement.

Returns:

queryString

setQueryString

public void setQueryString(String queryString)

scannedDataLimit

public AnalyticsQuery scannedDataLimit(BigDecimal scannedDataLimit)

getScannedDataLimit

public BigDecimal getScannedDataLimit()

The maximal amount of scanned data that this query is allowed to scan. After this limit is reached query will be canceled by the system.

Returns:

scannedDataLimit

setScannedDataLimit

public void setScannedDataLimit(BigDecimal scannedDataLimit)

spaceIds

public AnalyticsQuery spaceIds(List<Long> spaceIds)

addSpaceIdsItem

public AnalyticsQuery addSpaceIdsItem(Long spaceIdsItem)

getSpaceIds

public List<Long> getSpaceIds()

The IDs of the spaces in which the query shall be executed. At most 5 space IDs may be specified. All specified spaces must be owned by the account specified by the accountId property. The spaces property may be missing or empty to query all spaces of the specified account.

Returns:

spaceIds

setSpaceIds

public void setSpaceIds(List<Long> spaceIds)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object