com.datadog.api.client.v2.model

Class ObservabilityPipelineThrottleProcessor

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineThrottleProcessor

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

The throttle processor limits the number of events that pass through over a given time window.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_DISPLAY_NAME
static String	JSON_PROPERTY_ENABLED
static String	JSON_PROPERTY_GROUP_BY
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_INCLUDE
static String	JSON_PROPERTY_THRESHOLD
static String	JSON_PROPERTY_TYPE
static String	JSON_PROPERTY_WINDOW
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineThrottleProcessor()
ObservabilityPipelineThrottleProcessor(Boolean enabled, String id, String include, Long threshold, ObservabilityPipelineThrottleProcessorType type, Double window)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineThrottleProcessor	addGroupByItem(String groupByItem)
ObservabilityPipelineThrottleProcessor	displayName(String displayName)
ObservabilityPipelineThrottleProcessor	enabled(Boolean enabled)
boolean	equals(Object o) Return true if this ObservabilityPipelineThrottleProcessor 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.
List<String>	getGroupBy() Optional list of fields used to group events before the threshold has been reached.
String	getId() The unique identifier for this processor.
String	getInclude() A Datadog search query used to determine which logs this processor targets.
Long	getThreshold() the number of events allowed in a given time window.
ObservabilityPipelineThrottleProcessorType	getType() The processor type.
Double	getWindow() The time window in seconds over which the threshold applies.
ObservabilityPipelineThrottleProcessor	groupBy(List<String> groupBy)
int	hashCode()
ObservabilityPipelineThrottleProcessor	id(String id)
ObservabilityPipelineThrottleProcessor	include(String include)
ObservabilityPipelineThrottleProcessor	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	setGroupBy(List<String> groupBy)
void	setId(String id)
void	setInclude(String include)
void	setThreshold(Long threshold)
void	setType(ObservabilityPipelineThrottleProcessorType type)
void	setWindow(Double window)
ObservabilityPipelineThrottleProcessor	threshold(Long threshold)
String	toString()
ObservabilityPipelineThrottleProcessor	type(ObservabilityPipelineThrottleProcessorType type)
ObservabilityPipelineThrottleProcessor	window(Double window)

Methods inherited from class java.lang.Object

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

Field Detail

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_GROUP_BY

public static final String JSON_PROPERTY_GROUP_BY

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_THRESHOLD

public static final String JSON_PROPERTY_THRESHOLD

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_WINDOW

public static final String JSON_PROPERTY_WINDOW

See Also:

Constant Field Values

Constructor Detail

ObservabilityPipelineThrottleProcessor

public ObservabilityPipelineThrottleProcessor()

ObservabilityPipelineThrottleProcessor

public ObservabilityPipelineThrottleProcessor(Boolean enabled,
                                              String id,
                                              String include,
                                              Long threshold,
                                              ObservabilityPipelineThrottleProcessorType type,
                                              Double window)

Method Detail

displayName

public ObservabilityPipelineThrottleProcessor displayName(String displayName)

getDisplayName

@Nullable
public String getDisplayName()

The display name for a component.

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

enabled

public ObservabilityPipelineThrottleProcessor enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

Indicates whether the processor is enabled.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

groupBy

public ObservabilityPipelineThrottleProcessor groupBy(List<String> groupBy)

addGroupByItem

public ObservabilityPipelineThrottleProcessor addGroupByItem(String groupByItem)

getGroupBy

@Nullable
public List<String> getGroupBy()

Optional list of fields used to group events before the threshold has been reached.

Returns:

groupBy

setGroupBy

public void setGroupBy(List<String> groupBy)

id

public ObservabilityPipelineThrottleProcessor id(String id)

getId

public String getId()

The unique identifier for this processor.

Returns:

id

setId

public void setId(String id)

include

public ObservabilityPipelineThrottleProcessor include(String include)

getInclude

public String getInclude()

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

Returns:

include

setInclude

public void setInclude(String include)

threshold

public ObservabilityPipelineThrottleProcessor threshold(Long threshold)

getThreshold

public Long getThreshold()

the number of events allowed in a given time window. Events sent after the threshold has been reached, are dropped.

Returns:

threshold

setThreshold

public void setThreshold(Long threshold)

type

public ObservabilityPipelineThrottleProcessor type(ObservabilityPipelineThrottleProcessorType type)

getType

public ObservabilityPipelineThrottleProcessorType getType()

The processor type. The value should always be throttle.

Returns:

type

setType

public void setType(ObservabilityPipelineThrottleProcessorType type)

window

public ObservabilityPipelineThrottleProcessor window(Double window)

getWindow

public Double getWindow()

The time window in seconds over which the threshold applies.

Returns:

window

setWindow

public void setWindow(Double window)

putAdditionalProperty

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

ObservabilityPipelineThrottleProcessor

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