Package com.datadog.api.client.v2.model

Class ProductAnalyticsRetentionGridQuery

java.lang.Object

com.datadog.api.client.v2.model.ProductAnalyticsRetentionGridQuery

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

Query definition for a retention grid or retention metadata request.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ProductAnalyticsRetentionGridQuery()
ProductAnalyticsRetentionGridQuery(ProductAnalyticsRetentionCompute compute, ProductAnalyticsRetentionSearch search)

Method Summary

Modifier and Type	Method	Description
ProductAnalyticsRetentionGridQuery	addGroupByItem(ProductAnalyticsRetentionGroupBy groupByItem)
ProductAnalyticsRetentionGridQuery	computationScope(ProductAnalyticsRetentionScope computationScope)
ProductAnalyticsRetentionGridQuery	compute(ProductAnalyticsRetentionCompute compute)
boolean	equals(Object o)	Return true if this ProductAnalyticsRetentionGridQuery 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.
ProductAnalyticsRetentionGridQuery	groupBy(List<ProductAnalyticsRetentionGroupBy> groupBy)
int	hashCode()
ProductAnalyticsRetentionGridQuery	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
ProductAnalyticsRetentionGridQuery	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 Details

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 Details

ProductAnalyticsRetentionGridQuery

public ProductAnalyticsRetentionGridQuery()

ProductAnalyticsRetentionGridQuery

public ProductAnalyticsRetentionGridQuery(ProductAnalyticsRetentionCompute compute,
 ProductAnalyticsRetentionSearch search)

Method Details

computationScope

public ProductAnalyticsRetentionGridQuery 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 ProductAnalyticsRetentionGridQuery 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 ProductAnalyticsRetentionGridQuery groupBy(List<ProductAnalyticsRetentionGroupBy> groupBy)

addGroupByItem

public ProductAnalyticsRetentionGridQuery 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 ProductAnalyticsRetentionGridQuery 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 ProductAnalyticsRetentionGridQuery 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:

ProductAnalyticsRetentionGridQuery

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 ProductAnalyticsRetentionGridQuery 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