com.datadog.api.client.v2.model

Class ProductAnalyticsFormulaRetentionQuery

java.lang.Object

com.datadog.api.client.v2.model.ProductAnalyticsFormulaRetentionQuery

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class ProductAnalyticsFormulaRetentionQuery
extends Object

Query definition for a retention scalar or retention timeseries request.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_COMPUTATION_SCOPE
static String	JSON_PROPERTY_COMPUTE
static String	JSON_PROPERTY_GROUP_BY
static String	JSON_PROPERTY_SEARCH
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ProductAnalyticsFormulaRetentionQuery()
ProductAnalyticsFormulaRetentionQuery(ProductAnalyticsRetentionCompute compute, ProductAnalyticsRetentionSearch search)

Method Summary

Modifier and Type	Method and Description
ProductAnalyticsFormulaRetentionQuery	addGroupByItem(ProductAnalyticsRetentionGroupBy groupByItem)
ProductAnalyticsFormulaRetentionQuery	computationScope(ProductAnalyticsRetentionScope computationScope)
ProductAnalyticsFormulaRetentionQuery	compute(ProductAnalyticsRetentionCompute compute)
boolean	equals(Object o) Return true if this ProductAnalyticsFormulaRetentionQuery object is equal to o.
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
ProductAnalyticsRetentionScope	getComputationScope() Restricts a retention query to part of the grid, so that results can be examined in detail.
ProductAnalyticsRetentionCompute	getCompute() The metric and aggregation applied to a retention query.
List<ProductAnalyticsRetentionGroupBy>	getGroupBy() Splits the results by the values of one or more facets.
ProductAnalyticsRetentionSearch	getSearch() Defines the cohort and return criteria that make up a retention query.
ProductAnalyticsFormulaRetentionQuery	groupBy(List<ProductAnalyticsRetentionGroupBy> groupBy)
int	hashCode()
ProductAnalyticsFormulaRetentionQuery	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
ProductAnalyticsFormulaRetentionQuery	search(ProductAnalyticsRetentionSearch search)
void	setComputationScope(ProductAnalyticsRetentionScope computationScope)
void	setCompute(ProductAnalyticsRetentionCompute compute)
void	setGroupBy(List<ProductAnalyticsRetentionGroupBy> groupBy)
void	setSearch(ProductAnalyticsRetentionSearch search)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_COMPUTATION_SCOPE

public static final String JSON_PROPERTY_COMPUTATION_SCOPE

See Also:

Constant Field Values

JSON_PROPERTY_COMPUTE

public static final String JSON_PROPERTY_COMPUTE

See Also:

Constant Field Values

JSON_PROPERTY_GROUP_BY

public static final String JSON_PROPERTY_GROUP_BY

See Also:

Constant Field Values

JSON_PROPERTY_SEARCH

public static final String JSON_PROPERTY_SEARCH

See Also:

Constant Field Values

Constructor Detail

ProductAnalyticsFormulaRetentionQuery

public ProductAnalyticsFormulaRetentionQuery()

ProductAnalyticsFormulaRetentionQuery

public ProductAnalyticsFormulaRetentionQuery(ProductAnalyticsRetentionCompute compute,
                                             ProductAnalyticsRetentionSearch search)

Method Detail

computationScope

public ProductAnalyticsFormulaRetentionQuery computationScope(ProductAnalyticsRetentionScope computationScope)

getComputationScope

@Nullable
public ProductAnalyticsRetentionScope getComputationScope()

Restricts a retention query to part of the grid, so that results can be examined in detail. Omit it to compute the whole grid.

Returns:

computationScope

setComputationScope

public void setComputationScope(ProductAnalyticsRetentionScope computationScope)

compute

public ProductAnalyticsFormulaRetentionQuery compute(ProductAnalyticsRetentionCompute compute)

getCompute

public ProductAnalyticsRetentionCompute getCompute()

The metric and aggregation applied to a retention query.

Returns:

compute

setCompute

public void setCompute(ProductAnalyticsRetentionCompute compute)

groupBy

public ProductAnalyticsFormulaRetentionQuery groupBy(List<ProductAnalyticsRetentionGroupBy> groupBy)

addGroupByItem

public ProductAnalyticsFormulaRetentionQuery addGroupByItem(ProductAnalyticsRetentionGroupBy groupByItem)

getGroupBy

@Nullable
public List<ProductAnalyticsRetentionGroupBy> getGroupBy()

Splits the results by the values of one or more facets.

Returns:

groupBy

setGroupBy

public void setGroupBy(List<ProductAnalyticsRetentionGroupBy> groupBy)

search

public ProductAnalyticsFormulaRetentionQuery search(ProductAnalyticsRetentionSearch search)

getSearch

public ProductAnalyticsRetentionSearch getSearch()

Defines the cohort and return criteria that make up a retention query.

Returns:

search

setSearch

public void setSearch(ProductAnalyticsRetentionSearch search)

putAdditionalProperty

public ProductAnalyticsFormulaRetentionQuery putAdditionalProperty(String key,
                                                                   Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - The arbitrary key to set

value - The associated value

Returns:

ProductAnalyticsFormulaRetentionQuery

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

The additional properties

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - The arbitrary key to get

Returns:

The specific additional property for the given key

equals

public boolean equals(Object o)

Return true if this ProductAnalyticsFormulaRetentionQuery object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object