com.datadog.api.client.v2.model

Class ObservabilityPipelineSampleProcessor

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineSampleProcessor

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

The sample processor allows probabilistic sampling of logs at a fixed rate.

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_PERCENTAGE
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineSampleProcessor()
ObservabilityPipelineSampleProcessor(Boolean enabled, String id, String include, Double percentage, ObservabilityPipelineSampleProcessorType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineSampleProcessor	addGroupByItem(String groupByItem)
ObservabilityPipelineSampleProcessor	displayName(String displayName)
ObservabilityPipelineSampleProcessor	enabled(Boolean enabled)
boolean	equals(Object o) Return true if this ObservabilityPipelineSampleProcessor 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 to group events by.
String	getId() The unique identifier for this component.
String	getInclude() A Datadog search query used to determine which logs this processor targets.
Double	getPercentage() The percentage of logs to sample.
ObservabilityPipelineSampleProcessorType	getType() The processor type.
ObservabilityPipelineSampleProcessor	groupBy(List<String> groupBy)
int	hashCode()
ObservabilityPipelineSampleProcessor	id(String id)
ObservabilityPipelineSampleProcessor	include(String include)
ObservabilityPipelineSampleProcessor	percentage(Double percentage)
ObservabilityPipelineSampleProcessor	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	setPercentage(Double percentage)
void	setType(ObservabilityPipelineSampleProcessorType type)
String	toString()
ObservabilityPipelineSampleProcessor	type(ObservabilityPipelineSampleProcessorType 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_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_PERCENTAGE

public static final String JSON_PROPERTY_PERCENTAGE

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

ObservabilityPipelineSampleProcessor

public ObservabilityPipelineSampleProcessor()

ObservabilityPipelineSampleProcessor

public ObservabilityPipelineSampleProcessor(Boolean enabled,
                                            String id,
                                            String include,
                                            Double percentage,
                                            ObservabilityPipelineSampleProcessorType type)

Method Detail

displayName

public ObservabilityPipelineSampleProcessor displayName(String displayName)

getDisplayName

@Nullable
public String getDisplayName()

The display name for a component.

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

enabled

public ObservabilityPipelineSampleProcessor enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

Indicates whether the processor is enabled.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

groupBy

public ObservabilityPipelineSampleProcessor groupBy(List<String> groupBy)

addGroupByItem

public ObservabilityPipelineSampleProcessor addGroupByItem(String groupByItem)

getGroupBy

@Nullable
public List<String> getGroupBy()

Optional list of fields to group events by. Each group is sampled independently.

Returns:

groupBy

setGroupBy

public void setGroupBy(List<String> groupBy)

id

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

percentage

public ObservabilityPipelineSampleProcessor percentage(Double percentage)

getPercentage

public Double getPercentage()

The percentage of logs to sample.

Returns:

percentage

setPercentage

public void setPercentage(Double percentage)

type

public ObservabilityPipelineSampleProcessor type(ObservabilityPipelineSampleProcessorType type)

getType

public ObservabilityPipelineSampleProcessorType getType()

The processor type. The value should always be sample.

Returns:

type

setType

public void setType(ObservabilityPipelineSampleProcessorType type)

putAdditionalProperty

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

ObservabilityPipelineSampleProcessor

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