com.datadog.api.client.v2.model

Class ProductAnalyticsRetentionSearch

java.lang.Object

com.datadog.api.client.v2.model.ProductAnalyticsRetentionSearch

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_COHORT_CRITERIA
static String	JSON_PROPERTY_FILTERS
static String	JSON_PROPERTY_RETENTION_ENTITY
static String	JSON_PROPERTY_RETURN_CONDITION
static String	JSON_PROPERTY_RETURN_CRITERIA
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ProductAnalyticsRetentionSearch()
ProductAnalyticsRetentionSearch(ProductAnalyticsRetentionCohortCriteria cohortCriteria, ProductAnalyticsRetentionEntity retentionEntity, ProductAnalyticsRetentionReturnCondition returnCondition)

Method Summary

Modifier and Type	Method and Description
ProductAnalyticsRetentionSearch	cohortCriteria(ProductAnalyticsRetentionCohortCriteria cohortCriteria)
boolean	equals(Object o) Return true if this ProductAnalyticsRetentionSearch object is equal to o.
ProductAnalyticsRetentionSearch	filters(ProductAnalyticsRetentionFilters filters)
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
ProductAnalyticsRetentionCohortCriteria	getCohortCriteria() Defines the event that places an entity into a cohort, and how cohorts are bucketed over time.
ProductAnalyticsRetentionFilters	getFilters() Filters narrowing the events considered by a retention query.
ProductAnalyticsRetentionEntity	getRetentionEntity() The entity whose retention is measured.
ProductAnalyticsRetentionReturnCondition	getReturnCondition() When an entity counts as having returned.
ProductAnalyticsRetentionReturnCriteria	getReturnCriteria() Defines the event that counts as a return, and the window in which it must occur.
int	hashCode()
ProductAnalyticsRetentionSearch	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
ProductAnalyticsRetentionSearch	retentionEntity(ProductAnalyticsRetentionEntity retentionEntity)
ProductAnalyticsRetentionSearch	returnCondition(ProductAnalyticsRetentionReturnCondition returnCondition)
ProductAnalyticsRetentionSearch	returnCriteria(ProductAnalyticsRetentionReturnCriteria returnCriteria)
void	setCohortCriteria(ProductAnalyticsRetentionCohortCriteria cohortCriteria)
void	setFilters(ProductAnalyticsRetentionFilters filters)
void	setRetentionEntity(ProductAnalyticsRetentionEntity retentionEntity)
void	setReturnCondition(ProductAnalyticsRetentionReturnCondition returnCondition)
void	setReturnCriteria(ProductAnalyticsRetentionReturnCriteria returnCriteria)
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_COHORT_CRITERIA

public static final String JSON_PROPERTY_COHORT_CRITERIA

See Also:

Constant Field Values

JSON_PROPERTY_FILTERS

public static final String JSON_PROPERTY_FILTERS

See Also:

Constant Field Values

JSON_PROPERTY_RETENTION_ENTITY

public static final String JSON_PROPERTY_RETENTION_ENTITY

See Also:

Constant Field Values

JSON_PROPERTY_RETURN_CONDITION

public static final String JSON_PROPERTY_RETURN_CONDITION

See Also:

Constant Field Values

JSON_PROPERTY_RETURN_CRITERIA

public static final String JSON_PROPERTY_RETURN_CRITERIA

See Also:

Constant Field Values

Constructor Detail

ProductAnalyticsRetentionSearch

public ProductAnalyticsRetentionSearch()

ProductAnalyticsRetentionSearch

public ProductAnalyticsRetentionSearch(ProductAnalyticsRetentionCohortCriteria cohortCriteria,
                                       ProductAnalyticsRetentionEntity retentionEntity,
                                       ProductAnalyticsRetentionReturnCondition returnCondition)

Method Detail

cohortCriteria

public ProductAnalyticsRetentionSearch cohortCriteria(ProductAnalyticsRetentionCohortCriteria cohortCriteria)

getCohortCriteria

public ProductAnalyticsRetentionCohortCriteria getCohortCriteria()

Defines the event that places an entity into a cohort, and how cohorts are bucketed over time.

Returns:

cohortCriteria

setCohortCriteria

public void setCohortCriteria(ProductAnalyticsRetentionCohortCriteria cohortCriteria)

filters

public ProductAnalyticsRetentionSearch filters(ProductAnalyticsRetentionFilters filters)

getFilters

@Nullable
public ProductAnalyticsRetentionFilters getFilters()

Filters narrowing the events considered by a retention query.

Returns:

filters

setFilters

public void setFilters(ProductAnalyticsRetentionFilters filters)

retentionEntity

public ProductAnalyticsRetentionSearch retentionEntity(ProductAnalyticsRetentionEntity retentionEntity)

getRetentionEntity

public ProductAnalyticsRetentionEntity getRetentionEntity()

The entity whose retention is measured.

Returns:

retentionEntity

setRetentionEntity

public void setRetentionEntity(ProductAnalyticsRetentionEntity retentionEntity)

returnCondition

public ProductAnalyticsRetentionSearch returnCondition(ProductAnalyticsRetentionReturnCondition returnCondition)

getReturnCondition

public ProductAnalyticsRetentionReturnCondition getReturnCondition()

When an entity counts as having returned. Use conversion_on to count only entities that returned during the period itself, or conversion_on_or_after to also count later returns.

Returns:

returnCondition

setReturnCondition

public void setReturnCondition(ProductAnalyticsRetentionReturnCondition returnCondition)

returnCriteria

public ProductAnalyticsRetentionSearch returnCriteria(ProductAnalyticsRetentionReturnCriteria returnCriteria)

getReturnCriteria

@Nullable
public ProductAnalyticsRetentionReturnCriteria getReturnCriteria()

Defines the event that counts as a return, and the window in which it must occur.

Returns:

returnCriteria

setReturnCriteria

public void setReturnCriteria(ProductAnalyticsRetentionReturnCriteria returnCriteria)

putAdditionalProperty

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

ProductAnalyticsRetentionSearch

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