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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_INCLUDE
static String	JSON_PROPERTY_INPUTS
static String	JSON_PROPERTY_PERCENTAGE
static String	JSON_PROPERTY_RATE
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineSampleProcessor()
ObservabilityPipelineSampleProcessor(String id, String include, List<String> inputs, ObservabilityPipelineSampleProcessorType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineSampleProcessor	addInputsItem(String inputsItem)
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	getId() The unique identifier for this component.
String	getInclude() A Datadog search query used to determine which logs this processor targets.
List<String>	getInputs() A list of component IDs whose output is used as the input for this component.
Double	getPercentage() The percentage of logs to sample.
Long	getRate() Number of events to sample (1 in N).
ObservabilityPipelineSampleProcessorType	getType() The processor type.
int	hashCode()
ObservabilityPipelineSampleProcessor	id(String id)
ObservabilityPipelineSampleProcessor	include(String include)
ObservabilityPipelineSampleProcessor	inputs(List<String> inputs)
ObservabilityPipelineSampleProcessor	percentage(Double percentage)
ObservabilityPipelineSampleProcessor	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
ObservabilityPipelineSampleProcessor	rate(Long rate)
void	setId(String id)
void	setInclude(String include)
void	setInputs(List<String> inputs)
void	setPercentage(Double percentage)
void	setRate(Long rate)
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_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_INPUTS

public static final String JSON_PROPERTY_INPUTS

See Also:

Constant Field Values

JSON_PROPERTY_PERCENTAGE

public static final String JSON_PROPERTY_PERCENTAGE

See Also:

Constant Field Values

JSON_PROPERTY_RATE

public static final String JSON_PROPERTY_RATE

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(String id,
                                            String include,
                                            List<String> inputs,
                                            ObservabilityPipelineSampleProcessorType type)

Method Detail

id

public ObservabilityPipelineSampleProcessor id(String id)

getId

public String getId()

The unique identifier for this component. Used to reference this component in other parts of the pipeline (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)

inputs

public ObservabilityPipelineSampleProcessor inputs(List<String> inputs)

addInputsItem

public ObservabilityPipelineSampleProcessor addInputsItem(String inputsItem)

getInputs

public List<String> getInputs()

A list of component IDs whose output is used as the input for this component.

Returns:

inputs

setInputs

public void setInputs(List<String> inputs)

percentage

public ObservabilityPipelineSampleProcessor percentage(Double percentage)

getPercentage

@Nullable
public Double getPercentage()

The percentage of logs to sample.

Returns:

percentage

setPercentage

public void setPercentage(Double percentage)

rate

public ObservabilityPipelineSampleProcessor rate(Long rate)

getRate

@Nullable
public Long getRate()

Number of events to sample (1 in N). minimum: 1

Returns:

rate

setRate

public void setRate(Long rate)

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