ch.postfinance.sdk.model

Class AnalyticsQuery

java.lang.Object

ch.postfinance.sdk.model.AnalyticsQuery

public class AnalyticsQuery
extends Object

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 ID of the account in which the query is to be executed.
String	getExternalId() A client-generated nonce which uniquely identifies some action to be executed.
Integer	getMaxCacheAge() The maximum age (in minutes) of queries already executed that are to be taken into account.
String	getQueryString() The PrestoDB/Athena SQL statement to be executed.
BigDecimal	getScannedDataLimit() The maximum amount of data that the query is allowed to scan.
List<Long>	getSpaceIds() The IDs of the spaces belonging to the specified account in which the query is to 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 ID of the account in which the query is to be executed.

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 some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.

Returns:

externalId

setExternalId

public void setExternalId(String externalId)

maxCacheAge

public AnalyticsQuery maxCacheAge(Integer maxCacheAge)

getMaxCacheAge

public Integer getMaxCacheAge()

The maximum age (in minutes) of queries already executed that are to be taken into account. If an equivalent query is already available and not older than the specified age, its result will be returned instead of re-executing it. To force a new execution, specify a new, unique external ID and no maximum cache age.

Returns:

maxCacheAge

setMaxCacheAge

public void setMaxCacheAge(Integer maxCacheAge)

queryString

public AnalyticsQuery queryString(String queryString)

getQueryString

public String getQueryString()

The PrestoDB/Athena SQL statement to be executed.

Returns:

queryString

setQueryString

public void setQueryString(String queryString)

scannedDataLimit

public AnalyticsQuery scannedDataLimit(BigDecimal scannedDataLimit)

getScannedDataLimit

public BigDecimal getScannedDataLimit()

The maximum amount of data that the query is allowed to scan. After the limit is reached, the query will be canceled.

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 belonging to the specified account in which the query is to be executed. Do not provide any value to query all spaces in 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