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

Class ObservabilityPipelineTagCardinalityLimitProcessor

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineTagCardinalityLimitProcessor

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

The tag_cardinality_limit processor caps the number of distinct tag value combinations on metrics, dropping tags or events once the limit is exceeded.

Supported pipeline types: metrics

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_DISPLAY_NAME
static final String	JSON_PROPERTY_ENABLED
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_INCLUDE
static final String	JSON_PROPERTY_LIMIT_EXCEEDED_ACTION
static final String	JSON_PROPERTY_PER_METRIC_LIMITS
static final String	JSON_PROPERTY_TRACKING_MODE
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_VALUE_LIMIT
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
ObservabilityPipelineTagCardinalityLimitProcessor()
ObservabilityPipelineTagCardinalityLimitProcessor(Boolean enabled, String id, String include, ObservabilityPipelineTagCardinalityLimitProcessorAction limitExceededAction, ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode trackingMode, ObservabilityPipelineTagCardinalityLimitProcessorType type, Long valueLimit)

Method Summary

Modifier and Type	Method	Description
ObservabilityPipelineTagCardinalityLimitProcessor	addPerMetricLimitsItem(ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit perMetricLimitsItem)
ObservabilityPipelineTagCardinalityLimitProcessor	displayName(String displayName)
ObservabilityPipelineTagCardinalityLimitProcessor	enabled(Boolean enabled)
boolean	equals(Object o)	Return true if this ObservabilityPipelineTagCardinalityLimitProcessor 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.
String	getDisplayName()	The display name for a component.
Boolean	getEnabled()	Indicates whether the processor is enabled.
String	getId()	The unique identifier for this component.
String	getInclude()	A Datadog search query used to determine which metrics this processor targets.
ObservabilityPipelineTagCardinalityLimitProcessorAction	getLimitExceededAction()	The action to take when the cardinality limit is exceeded.
List<ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit>	getPerMetricLimits()	A list of per-metric cardinality overrides that take precedence over the default value_limit.
ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode	getTrackingMode()	Controls whether the processor uses exact or probabilistic tag tracking.
ObservabilityPipelineTagCardinalityLimitProcessorType	getType()	The processor type.
Long	getValueLimit()	The default maximum number of distinct tag value combinations allowed per metric.
int	hashCode()
ObservabilityPipelineTagCardinalityLimitProcessor	id(String id)
ObservabilityPipelineTagCardinalityLimitProcessor	include(String include)
ObservabilityPipelineTagCardinalityLimitProcessor	limitExceededAction(ObservabilityPipelineTagCardinalityLimitProcessorAction limitExceededAction)
ObservabilityPipelineTagCardinalityLimitProcessor	perMetricLimits(List<ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit> perMetricLimits)
ObservabilityPipelineTagCardinalityLimitProcessor	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setDisplayName(String displayName)
void	setEnabled(Boolean enabled)
void	setId(String id)
void	setInclude(String include)
void	setLimitExceededAction(ObservabilityPipelineTagCardinalityLimitProcessorAction limitExceededAction)
void	setPerMetricLimits(List<ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit> perMetricLimits)
void	setTrackingMode(ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode trackingMode)
void	setType(ObservabilityPipelineTagCardinalityLimitProcessorType type)
void	setValueLimit(Long valueLimit)
String	toString()
ObservabilityPipelineTagCardinalityLimitProcessor	trackingMode(ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode trackingMode)
ObservabilityPipelineTagCardinalityLimitProcessor	type(ObservabilityPipelineTagCardinalityLimitProcessorType type)
ObservabilityPipelineTagCardinalityLimitProcessor	valueLimit(Long valueLimit)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_DISPLAY_NAME

public static final String JSON_PROPERTY_DISPLAY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_ENABLED

public static final String JSON_PROPERTY_ENABLED

See Also:

• Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

• Constant Field Values

JSON_PROPERTY_INCLUDE

public static final String JSON_PROPERTY_INCLUDE

See Also:

• Constant Field Values

JSON_PROPERTY_LIMIT_EXCEEDED_ACTION

public static final String JSON_PROPERTY_LIMIT_EXCEEDED_ACTION

See Also:

• Constant Field Values

JSON_PROPERTY_PER_METRIC_LIMITS

public static final String JSON_PROPERTY_PER_METRIC_LIMITS

See Also:

• Constant Field Values

JSON_PROPERTY_TRACKING_MODE

public static final String JSON_PROPERTY_TRACKING_MODE

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_VALUE_LIMIT

public static final String JSON_PROPERTY_VALUE_LIMIT

See Also:

• Constant Field Values

Constructor Details

ObservabilityPipelineTagCardinalityLimitProcessor

public ObservabilityPipelineTagCardinalityLimitProcessor()

ObservabilityPipelineTagCardinalityLimitProcessor

public ObservabilityPipelineTagCardinalityLimitProcessor(Boolean enabled,
 String id,
 String include,
 ObservabilityPipelineTagCardinalityLimitProcessorAction limitExceededAction,
 ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode trackingMode,
 ObservabilityPipelineTagCardinalityLimitProcessorType type,
 Long valueLimit)

Method Details

displayName

public ObservabilityPipelineTagCardinalityLimitProcessor displayName(String displayName)

getDisplayName

@Nullable
public String getDisplayName()

The display name for a component.

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

enabled

public ObservabilityPipelineTagCardinalityLimitProcessor enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

Indicates whether the processor is enabled.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

id

public ObservabilityPipelineTagCardinalityLimitProcessor id(String id)

getId

public String getId()

The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the input to downstream components).

Returns:

id

setId

public void setId(String id)

include

public ObservabilityPipelineTagCardinalityLimitProcessor include(String include)

getInclude

public String getInclude()

A Datadog search query used to determine which metrics this processor targets.

Returns:

include

setInclude

public void setInclude(String include)

limitExceededAction

public ObservabilityPipelineTagCardinalityLimitProcessor limitExceededAction(ObservabilityPipelineTagCardinalityLimitProcessorAction limitExceededAction)

getLimitExceededAction

public ObservabilityPipelineTagCardinalityLimitProcessorAction getLimitExceededAction()

The action to take when the cardinality limit is exceeded.

Returns:

limitExceededAction

setLimitExceededAction

public void setLimitExceededAction(ObservabilityPipelineTagCardinalityLimitProcessorAction limitExceededAction)

perMetricLimits

public ObservabilityPipelineTagCardinalityLimitProcessor perMetricLimits(List<ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit> perMetricLimits)

addPerMetricLimitsItem

public ObservabilityPipelineTagCardinalityLimitProcessor addPerMetricLimitsItem(ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit perMetricLimitsItem)

getPerMetricLimits

@Nullable
public List<ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit> getPerMetricLimits()

A list of per-metric cardinality overrides that take precedence over the default value_limit.

Returns:

perMetricLimits

setPerMetricLimits

public void setPerMetricLimits(List<ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit> perMetricLimits)

trackingMode

public ObservabilityPipelineTagCardinalityLimitProcessor trackingMode(ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode trackingMode)

getTrackingMode

public ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode getTrackingMode()

Controls whether the processor uses exact or probabilistic tag tracking.

Returns:

trackingMode

setTrackingMode

public void setTrackingMode(ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode trackingMode)

type

public ObservabilityPipelineTagCardinalityLimitProcessor type(ObservabilityPipelineTagCardinalityLimitProcessorType type)

getType

public ObservabilityPipelineTagCardinalityLimitProcessorType getType()

The processor type. The value must be tag_cardinality_limit.

Returns:

type

setType

public void setType(ObservabilityPipelineTagCardinalityLimitProcessorType type)

valueLimit

public ObservabilityPipelineTagCardinalityLimitProcessor valueLimit(Long valueLimit)

getValueLimit

public Long getValueLimit()

The default maximum number of distinct tag value combinations allowed per metric. minimum: 0 maximum: 1000000

Returns:

valueLimit

setValueLimit

public void setValueLimit(Long valueLimit)

putAdditionalProperty

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

ObservabilityPipelineTagCardinalityLimitProcessor

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