com.datadog.api.client.v2.model

Class ApmMetricsQuery

java.lang.Object

com.datadog.api.client.v2.model.ApmMetricsQuery

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

A query for APM trace metrics such as hits, errors, and latency percentiles, aggregated across services.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_CROSS_ORG_UUIDS
static String	JSON_PROPERTY_DATA_SOURCE
static String	JSON_PROPERTY_GROUP_BY
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_OPERATION_MODE
static String	JSON_PROPERTY_OPERATION_NAME
static String	JSON_PROPERTY_PEER_TAGS
static String	JSON_PROPERTY_QUERY_FILTER
static String	JSON_PROPERTY_RESOURCE_HASH
static String	JSON_PROPERTY_RESOURCE_NAME
static String	JSON_PROPERTY_SERVICE
static String	JSON_PROPERTY_SPAN_KIND
static String	JSON_PROPERTY_STAT
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ApmMetricsQuery()
ApmMetricsQuery(ApmMetricsDataSource dataSource, String name, ApmMetricsStat stat)

Method Summary

Modifier and Type	Method and Description
ApmMetricsQuery	addCrossOrgUuidsItem(String crossOrgUuidsItem)
ApmMetricsQuery	addGroupByItem(String groupByItem)
ApmMetricsQuery	addPeerTagsItem(String peerTagsItem)
ApmMetricsQuery	crossOrgUuids(List<String> crossOrgUuids)
ApmMetricsQuery	dataSource(ApmMetricsDataSource dataSource)
boolean	equals(Object o) Return true if this ApmMetricsQuery 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.
List<String>	getCrossOrgUuids() Organization UUIDs to query when using cross-organization visibility.
ApmMetricsDataSource	getDataSource() A data source for APM metrics queries.
List<String>	getGroupBy() Optional fields to group the query results by.
String	getName() The variable name for use in formulas.
String	getOperationMode() Optional operation mode to aggregate across operation names.
String	getOperationName() Name of operation on service.
List<String>	getPeerTags() Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
String	getQueryFilter() Additional filters for the query using metrics query syntax (for example, env, primary_tag).
String	getResourceHash() The resource hash for exact matching.
String	getResourceName() The full name of a specific resource to filter by.
String	getService() The service name to filter by.
ApmMetricsSpanKind	getSpanKind() Describes the relationship between the span, its parents, and its children in a trace.
ApmMetricsStat	getStat() The APM metric statistic to query.
ApmMetricsQuery	groupBy(List<String> groupBy)
int	hashCode()
ApmMetricsQuery	name(String name)
ApmMetricsQuery	operationMode(String operationMode)
ApmMetricsQuery	operationName(String operationName)
ApmMetricsQuery	peerTags(List<String> peerTags)
ApmMetricsQuery	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
ApmMetricsQuery	queryFilter(String queryFilter)
ApmMetricsQuery	resourceHash(String resourceHash)
ApmMetricsQuery	resourceName(String resourceName)
ApmMetricsQuery	service(String service)
void	setCrossOrgUuids(List<String> crossOrgUuids)
void	setDataSource(ApmMetricsDataSource dataSource)
void	setGroupBy(List<String> groupBy)
void	setName(String name)
void	setOperationMode(String operationMode)
void	setOperationName(String operationName)
void	setPeerTags(List<String> peerTags)
void	setQueryFilter(String queryFilter)
void	setResourceHash(String resourceHash)
void	setResourceName(String resourceName)
void	setService(String service)
void	setSpanKind(ApmMetricsSpanKind spanKind)
void	setStat(ApmMetricsStat stat)
ApmMetricsQuery	spanKind(ApmMetricsSpanKind spanKind)
ApmMetricsQuery	stat(ApmMetricsStat stat)
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_CROSS_ORG_UUIDS

public static final String JSON_PROPERTY_CROSS_ORG_UUIDS

See Also:

Constant Field Values

JSON_PROPERTY_DATA_SOURCE

public static final String JSON_PROPERTY_DATA_SOURCE

See Also:

Constant Field Values

JSON_PROPERTY_GROUP_BY

public static final String JSON_PROPERTY_GROUP_BY

See Also:

Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_OPERATION_MODE

public static final String JSON_PROPERTY_OPERATION_MODE

See Also:

Constant Field Values

JSON_PROPERTY_OPERATION_NAME

public static final String JSON_PROPERTY_OPERATION_NAME

See Also:

Constant Field Values

JSON_PROPERTY_PEER_TAGS

public static final String JSON_PROPERTY_PEER_TAGS

See Also:

Constant Field Values

JSON_PROPERTY_QUERY_FILTER

public static final String JSON_PROPERTY_QUERY_FILTER

See Also:

Constant Field Values

JSON_PROPERTY_RESOURCE_HASH

public static final String JSON_PROPERTY_RESOURCE_HASH

See Also:

Constant Field Values

JSON_PROPERTY_RESOURCE_NAME

public static final String JSON_PROPERTY_RESOURCE_NAME

See Also:

Constant Field Values

JSON_PROPERTY_SERVICE

public static final String JSON_PROPERTY_SERVICE

See Also:

Constant Field Values

JSON_PROPERTY_SPAN_KIND

public static final String JSON_PROPERTY_SPAN_KIND

See Also:

Constant Field Values

JSON_PROPERTY_STAT

public static final String JSON_PROPERTY_STAT

See Also:

Constant Field Values

Constructor Detail

ApmMetricsQuery

public ApmMetricsQuery()

ApmMetricsQuery

public ApmMetricsQuery(ApmMetricsDataSource dataSource,
                       String name,
                       ApmMetricsStat stat)

Method Detail

crossOrgUuids

public ApmMetricsQuery crossOrgUuids(List<String> crossOrgUuids)

addCrossOrgUuidsItem

public ApmMetricsQuery addCrossOrgUuidsItem(String crossOrgUuidsItem)

getCrossOrgUuids

@Nullable
public List<String> getCrossOrgUuids()

Organization UUIDs to query when using cross-organization visibility. Limited to one organization UUID.

Returns:

crossOrgUuids

setCrossOrgUuids

public void setCrossOrgUuids(List<String> crossOrgUuids)

dataSource

public ApmMetricsQuery dataSource(ApmMetricsDataSource dataSource)

getDataSource

public ApmMetricsDataSource getDataSource()

A data source for APM metrics queries.

Returns:

dataSource

setDataSource

public void setDataSource(ApmMetricsDataSource dataSource)

groupBy

public ApmMetricsQuery groupBy(List<String> groupBy)

addGroupByItem

public ApmMetricsQuery addGroupByItem(String groupByItem)

getGroupBy

@Nullable
public List<String> getGroupBy()

Optional fields to group the query results by.

Returns:

groupBy

setGroupBy

public void setGroupBy(List<String> groupBy)

name

public ApmMetricsQuery name(String name)

getName

public String getName()

The variable name for use in formulas.

Returns:

name

setName

public void setName(String name)

operationMode

public ApmMetricsQuery operationMode(String operationMode)

getOperationMode

@Nullable
public String getOperationMode()

Optional operation mode to aggregate across operation names.

Returns:

operationMode

setOperationMode

public void setOperationMode(String operationMode)

operationName

public ApmMetricsQuery operationName(String operationName)

getOperationName

@Nullable
public String getOperationName()

Name of operation on service. If not provided, the primary operation name is used.

Returns:

operationName

setOperationName

public void setOperationName(String operationName)

peerTags

public ApmMetricsQuery peerTags(List<String> peerTags)

addPeerTagsItem

public ApmMetricsQuery addPeerTagsItem(String peerTagsItem)

getPeerTags

@Nullable
public List<String> getPeerTags()

Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).

Returns:

peerTags

setPeerTags

public void setPeerTags(List<String> peerTags)

queryFilter

public ApmMetricsQuery queryFilter(String queryFilter)

getQueryFilter

@Nullable
public String getQueryFilter()

Additional filters for the query using metrics query syntax (for example, env, primary_tag).

Returns:

queryFilter

setQueryFilter

public void setQueryFilter(String queryFilter)

resourceHash

public ApmMetricsQuery resourceHash(String resourceHash)

getResourceHash

@Nullable
public String getResourceHash()

The resource hash for exact matching.

Returns:

resourceHash

setResourceHash

public void setResourceHash(String resourceHash)

resourceName

public ApmMetricsQuery resourceName(String resourceName)

getResourceName

@Nullable
public String getResourceName()

The full name of a specific resource to filter by.

Returns:

resourceName

setResourceName

public void setResourceName(String resourceName)

service

public ApmMetricsQuery service(String service)

getService

@Nullable
public String getService()

The service name to filter by.

Returns:

service

setService

public void setService(String service)

spanKind

public ApmMetricsQuery spanKind(ApmMetricsSpanKind spanKind)

getSpanKind

@Nullable
public ApmMetricsSpanKind getSpanKind()

Describes the relationship between the span, its parents, and its children in a trace.

Returns:

spanKind

setSpanKind

public void setSpanKind(ApmMetricsSpanKind spanKind)

stat

public ApmMetricsQuery stat(ApmMetricsStat stat)

getStat

public ApmMetricsStat getStat()

The APM metric statistic to query.

Returns:

stat

setStat

public void setStat(ApmMetricsStat stat)

putAdditionalProperty

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

ApmMetricsQuery

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