com.datadog.api.client.v2.model

Class ObservabilityPipelineQuotaProcessor

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineQuotaProcessor

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

The quota processor measures logging traffic for logs that match a specified filter. When the configured daily quota is met, the processor can drop or alert.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_DISPLAY_NAME
static String	JSON_PROPERTY_DROP_EVENTS
static String	JSON_PROPERTY_ENABLED
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_IGNORE_WHEN_MISSING_PARTITIONS
static String	JSON_PROPERTY_INCLUDE
static String	JSON_PROPERTY_LIMIT
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_OVERFLOW_ACTION
static String	JSON_PROPERTY_OVERRIDES
static String	JSON_PROPERTY_PARTITION_FIELDS
static String	JSON_PROPERTY_TOO_MANY_BUCKETS_ACTION
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineQuotaProcessor()
ObservabilityPipelineQuotaProcessor(Boolean enabled, String id, String include, ObservabilityPipelineQuotaProcessorLimit limit, String name, ObservabilityPipelineQuotaProcessorType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineQuotaProcessor	addOverridesItem(ObservabilityPipelineQuotaProcessorOverride overridesItem)
ObservabilityPipelineQuotaProcessor	addPartitionFieldsItem(String partitionFieldsItem)
ObservabilityPipelineQuotaProcessor	displayName(String displayName)
ObservabilityPipelineQuotaProcessor	dropEvents(Boolean dropEvents)
ObservabilityPipelineQuotaProcessor	enabled(Boolean enabled)
boolean	equals(Object o) Return true if this ObservabilityPipelineQuotaProcessor 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	getDropEvents() If set to true, logs that match the quota filter and are sent after the quota is exceeded are dropped.
Boolean	getEnabled() Indicates whether the processor is enabled.
String	getId() The unique identifier for this component.
Boolean	getIgnoreWhenMissingPartitions() If true, the processor skips quota checks when partition fields are missing from the logs.
String	getInclude() A Datadog search query used to determine which logs this processor targets.
ObservabilityPipelineQuotaProcessorLimit	getLimit() The maximum amount of data or number of events allowed before the quota is enforced.
String	getName() Name of the quota.
ObservabilityPipelineQuotaProcessorOverflowAction	getOverflowAction() The action to take when the quota or bucket limit is exceeded.
List<ObservabilityPipelineQuotaProcessorOverride>	getOverrides() A list of alternate quota rules that apply to specific sets of events, identified by matching field values.
List<String>	getPartitionFields() A list of fields used to segment log traffic for quota enforcement.
ObservabilityPipelineQuotaProcessorOverflowAction	getTooManyBucketsAction() The action to take when the quota or bucket limit is exceeded.
ObservabilityPipelineQuotaProcessorType	getType() The processor type.
int	hashCode()
ObservabilityPipelineQuotaProcessor	id(String id)
ObservabilityPipelineQuotaProcessor	ignoreWhenMissingPartitions(Boolean ignoreWhenMissingPartitions)
ObservabilityPipelineQuotaProcessor	include(String include)
ObservabilityPipelineQuotaProcessor	limit(ObservabilityPipelineQuotaProcessorLimit limit)
ObservabilityPipelineQuotaProcessor	name(String name)
ObservabilityPipelineQuotaProcessor	overflowAction(ObservabilityPipelineQuotaProcessorOverflowAction overflowAction)
ObservabilityPipelineQuotaProcessor	overrides(List<ObservabilityPipelineQuotaProcessorOverride> overrides)
ObservabilityPipelineQuotaProcessor	partitionFields(List<String> partitionFields)
ObservabilityPipelineQuotaProcessor	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setDisplayName(String displayName)
void	setDropEvents(Boolean dropEvents)
void	setEnabled(Boolean enabled)
void	setId(String id)
void	setIgnoreWhenMissingPartitions(Boolean ignoreWhenMissingPartitions)
void	setInclude(String include)
void	setLimit(ObservabilityPipelineQuotaProcessorLimit limit)
void	setName(String name)
void	setOverflowAction(ObservabilityPipelineQuotaProcessorOverflowAction overflowAction)
void	setOverrides(List<ObservabilityPipelineQuotaProcessorOverride> overrides)
void	setPartitionFields(List<String> partitionFields)
void	setTooManyBucketsAction(ObservabilityPipelineQuotaProcessorOverflowAction tooManyBucketsAction)
void	setType(ObservabilityPipelineQuotaProcessorType type)
ObservabilityPipelineQuotaProcessor	tooManyBucketsAction(ObservabilityPipelineQuotaProcessorOverflowAction tooManyBucketsAction)
String	toString()
ObservabilityPipelineQuotaProcessor	type(ObservabilityPipelineQuotaProcessorType type)

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_DROP_EVENTS

public static final String JSON_PROPERTY_DROP_EVENTS

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_IGNORE_WHEN_MISSING_PARTITIONS

public static final String JSON_PROPERTY_IGNORE_WHEN_MISSING_PARTITIONS

See Also:

Constant Field Values

JSON_PROPERTY_INCLUDE

public static final String JSON_PROPERTY_INCLUDE

See Also:

Constant Field Values

JSON_PROPERTY_LIMIT

public static final String JSON_PROPERTY_LIMIT

See Also:

Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_OVERFLOW_ACTION

public static final String JSON_PROPERTY_OVERFLOW_ACTION

See Also:

Constant Field Values

JSON_PROPERTY_OVERRIDES

public static final String JSON_PROPERTY_OVERRIDES

See Also:

Constant Field Values

JSON_PROPERTY_PARTITION_FIELDS

public static final String JSON_PROPERTY_PARTITION_FIELDS

See Also:

Constant Field Values

JSON_PROPERTY_TOO_MANY_BUCKETS_ACTION

public static final String JSON_PROPERTY_TOO_MANY_BUCKETS_ACTION

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

ObservabilityPipelineQuotaProcessor

public ObservabilityPipelineQuotaProcessor()

ObservabilityPipelineQuotaProcessor

public ObservabilityPipelineQuotaProcessor(Boolean enabled,
                                           String id,
                                           String include,
                                           ObservabilityPipelineQuotaProcessorLimit limit,
                                           String name,
                                           ObservabilityPipelineQuotaProcessorType type)

Method Detail

displayName

public ObservabilityPipelineQuotaProcessor displayName(String displayName)

getDisplayName

@Nullable
public String getDisplayName()

The display name for a component.

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

dropEvents

public ObservabilityPipelineQuotaProcessor dropEvents(Boolean dropEvents)

getDropEvents

@Nullable
public Boolean getDropEvents()

If set to true, logs that match the quota filter and are sent after the quota is exceeded are dropped. Logs that do not match the filter continue through the pipeline. Note: You can set either drop_events or overflow_action , but not both.

Returns:

dropEvents

setDropEvents

public void setDropEvents(Boolean dropEvents)

enabled

public ObservabilityPipelineQuotaProcessor enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

Indicates whether the processor is enabled.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

id

public ObservabilityPipelineQuotaProcessor 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)

ignoreWhenMissingPartitions

public ObservabilityPipelineQuotaProcessor ignoreWhenMissingPartitions(Boolean ignoreWhenMissingPartitions)

getIgnoreWhenMissingPartitions

@Nullable
public Boolean getIgnoreWhenMissingPartitions()

If true, the processor skips quota checks when partition fields are missing from the logs.

Returns:

ignoreWhenMissingPartitions

setIgnoreWhenMissingPartitions

public void setIgnoreWhenMissingPartitions(Boolean ignoreWhenMissingPartitions)

include

public ObservabilityPipelineQuotaProcessor 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)

limit

public ObservabilityPipelineQuotaProcessor limit(ObservabilityPipelineQuotaProcessorLimit limit)

getLimit

public ObservabilityPipelineQuotaProcessorLimit getLimit()

The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events.

Returns:

limit

setLimit

public void setLimit(ObservabilityPipelineQuotaProcessorLimit limit)

name

public ObservabilityPipelineQuotaProcessor name(String name)

getName

public String getName()

Name of the quota.

Returns:

name

setName

public void setName(String name)

overflowAction

public ObservabilityPipelineQuotaProcessor overflowAction(ObservabilityPipelineQuotaProcessorOverflowAction overflowAction)

getOverflowAction

@Nullable
public ObservabilityPipelineQuotaProcessorOverflowAction getOverflowAction()

The action to take when the quota or bucket limit is exceeded. Options: - drop: Drop the event. - no_action: Let the event pass through. - overflow_routing : Route to an overflow destination.

Returns:

overflowAction

setOverflowAction

public void setOverflowAction(ObservabilityPipelineQuotaProcessorOverflowAction overflowAction)

overrides

public ObservabilityPipelineQuotaProcessor overrides(List<ObservabilityPipelineQuotaProcessorOverride> overrides)

addOverridesItem

public ObservabilityPipelineQuotaProcessor addOverridesItem(ObservabilityPipelineQuotaProcessorOverride overridesItem)

getOverrides

@Nullable
public List<ObservabilityPipelineQuotaProcessorOverride> getOverrides()

A list of alternate quota rules that apply to specific sets of events, identified by matching field values. Each override can define a custom limit.

Returns:

overrides

setOverrides

public void setOverrides(List<ObservabilityPipelineQuotaProcessorOverride> overrides)

partitionFields

public ObservabilityPipelineQuotaProcessor partitionFields(List<String> partitionFields)

addPartitionFieldsItem

public ObservabilityPipelineQuotaProcessor addPartitionFieldsItem(String partitionFieldsItem)

getPartitionFields

@Nullable
public List<String> getPartitionFields()

A list of fields used to segment log traffic for quota enforcement. Quotas are tracked independently by unique combinations of these field values.

Returns:

partitionFields

setPartitionFields

public void setPartitionFields(List<String> partitionFields)

tooManyBucketsAction

public ObservabilityPipelineQuotaProcessor tooManyBucketsAction(ObservabilityPipelineQuotaProcessorOverflowAction tooManyBucketsAction)

getTooManyBucketsAction

@Nullable
public ObservabilityPipelineQuotaProcessorOverflowAction getTooManyBucketsAction()

The action to take when the quota or bucket limit is exceeded. Options: - drop: Drop the event. - no_action: Let the event pass through. - overflow_routing : Route to an overflow destination.

Returns:

tooManyBucketsAction

setTooManyBucketsAction

public void setTooManyBucketsAction(ObservabilityPipelineQuotaProcessorOverflowAction tooManyBucketsAction)

type

public ObservabilityPipelineQuotaProcessor type(ObservabilityPipelineQuotaProcessorType type)

getType

public ObservabilityPipelineQuotaProcessorType getType()

The processor type. The value should always be quota.

Returns:

type

setType

public void setType(ObservabilityPipelineQuotaProcessorType type)

putAdditionalProperty

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

ObservabilityPipelineQuotaProcessor

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