com.datadog.api.client.v2.model

Class ProductAnalyticsAnalyticsListQuery

java.lang.Object

com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsListQuery

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

The analytics list query definition. It selects the events to return with query, then chooses the columns on each event row, the sort applied to those rows, and a row limit. Unlike the scalar and timeseries queries, a list query returns raw event rows rather than aggregates, so it takes no compute or group-by rule.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_AUDIENCE_FILTERS
static String	JSON_PROPERTY_COLUMNS
static String	JSON_PROPERTY_LIMIT
static String	JSON_PROPERTY_QUERY
static String	JSON_PROPERTY_SORT
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ProductAnalyticsAnalyticsListQuery()
ProductAnalyticsAnalyticsListQuery(ProductAnalyticsBaseQuery query)

Method Summary

Modifier and Type	Method and Description
ProductAnalyticsAnalyticsListQuery	addColumnsItem(String columnsItem)
ProductAnalyticsAnalyticsListQuery	audienceFilters(ProductAnalyticsAudienceFilters audienceFilters)
ProductAnalyticsAnalyticsListQuery	columns(List<String> columns)
boolean	equals(Object o) Return true if this ProductAnalyticsAnalyticsListQuery 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.
ProductAnalyticsAudienceFilters	getAudienceFilters() Audience filter definitions for targeting specific user segments.
List<String>	getColumns() Attribute columns to include in each event row.
Long	getLimit() Maximum number of event rows to return.
ProductAnalyticsBaseQuery	getQuery() A query definition discriminated by the data_source field.
ProductAnalyticsAnalyticsListSort	getSort() The sort applied to the returned event rows.
int	hashCode()
ProductAnalyticsAnalyticsListQuery	limit(Long limit)
ProductAnalyticsAnalyticsListQuery	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
ProductAnalyticsAnalyticsListQuery	query(ProductAnalyticsBaseQuery query)
void	setAudienceFilters(ProductAnalyticsAudienceFilters audienceFilters)
void	setColumns(List<String> columns)
void	setLimit(Long limit)
void	setQuery(ProductAnalyticsBaseQuery query)
void	setSort(ProductAnalyticsAnalyticsListSort sort)
ProductAnalyticsAnalyticsListQuery	sort(ProductAnalyticsAnalyticsListSort sort)
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_AUDIENCE_FILTERS

public static final String JSON_PROPERTY_AUDIENCE_FILTERS

See Also:

Constant Field Values

JSON_PROPERTY_COLUMNS

public static final String JSON_PROPERTY_COLUMNS

See Also:

Constant Field Values

JSON_PROPERTY_LIMIT

public static final String JSON_PROPERTY_LIMIT

See Also:

Constant Field Values

JSON_PROPERTY_QUERY

public static final String JSON_PROPERTY_QUERY

See Also:

Constant Field Values

JSON_PROPERTY_SORT

public static final String JSON_PROPERTY_SORT

See Also:

Constant Field Values

Constructor Detail

ProductAnalyticsAnalyticsListQuery

public ProductAnalyticsAnalyticsListQuery()

ProductAnalyticsAnalyticsListQuery

public ProductAnalyticsAnalyticsListQuery(ProductAnalyticsBaseQuery query)

Method Detail

audienceFilters

public ProductAnalyticsAnalyticsListQuery audienceFilters(ProductAnalyticsAudienceFilters audienceFilters)

getAudienceFilters

@Nullable
public ProductAnalyticsAudienceFilters getAudienceFilters()

Audience filter definitions for targeting specific user segments.

Returns:

audienceFilters

setAudienceFilters

public void setAudienceFilters(ProductAnalyticsAudienceFilters audienceFilters)

columns

public ProductAnalyticsAnalyticsListQuery columns(List<String> columns)

addColumnsItem

public ProductAnalyticsAnalyticsListQuery addColumnsItem(String columnsItem)

getColumns

@Nullable
public List<String> getColumns()

Attribute columns to include in each event row.

Returns:

columns

setColumns

public void setColumns(List<String> columns)

limit

public ProductAnalyticsAnalyticsListQuery limit(Long limit)

getLimit

@Nullable
public Long getLimit()

Maximum number of event rows to return. minimum: 1 maximum: 1000

Returns:

limit

setLimit

public void setLimit(Long limit)

query

public ProductAnalyticsAnalyticsListQuery query(ProductAnalyticsBaseQuery query)

getQuery

public ProductAnalyticsBaseQuery getQuery()

A query definition discriminated by the data_source field. Use product_analytics for standard event queries, or product_analytics_occurrence for occurrence-filtered queries.

Returns:

query

setQuery

public void setQuery(ProductAnalyticsBaseQuery query)

sort

public ProductAnalyticsAnalyticsListQuery sort(ProductAnalyticsAnalyticsListSort sort)

getSort

@Nullable
public ProductAnalyticsAnalyticsListSort getSort()

The sort applied to the returned event rows.

Returns:

sort

setSort

public void setSort(ProductAnalyticsAnalyticsListSort sort)

putAdditionalProperty

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

ProductAnalyticsAnalyticsListQuery

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