com.datadog.api.client.v2.model

Class RetentionFilterCreateAttributes

java.lang.Object

com.datadog.api.client.v2.model.RetentionFilterCreateAttributes

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

The object describing the configuration of the retention filter to create/update.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ENABLED
static String	JSON_PROPERTY_FILTER
static String	JSON_PROPERTY_FILTER_TYPE
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_RATE
static String	JSON_PROPERTY_TRACE_RATE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
RetentionFilterCreateAttributes()
RetentionFilterCreateAttributes(Boolean enabled, SpansFilterCreate filter, RetentionFilterType filterType, String name, Double rate)

Method Summary

Modifier and Type	Method and Description
RetentionFilterCreateAttributes	enabled(Boolean enabled)
boolean	equals(Object o) Return true if this RetentionFilterCreateAttributes object is equal to o.
RetentionFilterCreateAttributes	filter(SpansFilterCreate filter)
RetentionFilterCreateAttributes	filterType(RetentionFilterType filterType)
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
Boolean	getEnabled() Enable/Disable the retention filter.
SpansFilterCreate	getFilter() The spans filter.
RetentionFilterType	getFilterType() The type of retention filter.
String	getName() The name of the retention filter.
Double	getRate() Sample rate to apply to spans going through this retention filter.
Double	getTraceRate() Sample rate to apply to traces containing spans going through this retention filter.
int	hashCode()
RetentionFilterCreateAttributes	name(String name)
RetentionFilterCreateAttributes	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
RetentionFilterCreateAttributes	rate(Double rate)
void	setEnabled(Boolean enabled)
void	setFilter(SpansFilterCreate filter)
void	setFilterType(RetentionFilterType filterType)
void	setName(String name)
void	setRate(Double rate)
void	setTraceRate(Double traceRate)
String	toString()
RetentionFilterCreateAttributes	traceRate(Double traceRate)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_ENABLED

public static final String JSON_PROPERTY_ENABLED

See Also:

Constant Field Values

JSON_PROPERTY_FILTER

public static final String JSON_PROPERTY_FILTER

See Also:

Constant Field Values

JSON_PROPERTY_FILTER_TYPE

public static final String JSON_PROPERTY_FILTER_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_RATE

public static final String JSON_PROPERTY_RATE

See Also:

Constant Field Values

JSON_PROPERTY_TRACE_RATE

public static final String JSON_PROPERTY_TRACE_RATE

See Also:

Constant Field Values

Constructor Detail

RetentionFilterCreateAttributes

public RetentionFilterCreateAttributes()

RetentionFilterCreateAttributes

public RetentionFilterCreateAttributes(Boolean enabled,
                                       SpansFilterCreate filter,
                                       RetentionFilterType filterType,
                                       String name,
                                       Double rate)

Method Detail

enabled

public RetentionFilterCreateAttributes enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

Enable/Disable the retention filter.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

filter

public RetentionFilterCreateAttributes filter(SpansFilterCreate filter)

getFilter

public SpansFilterCreate getFilter()

The spans filter. Spans matching this filter will be indexed and stored.

Returns:

filter

setFilter

public void setFilter(SpansFilterCreate filter)

filterType

public RetentionFilterCreateAttributes filterType(RetentionFilterType filterType)

getFilterType

public RetentionFilterType getFilterType()

The type of retention filter. The value should always be spans-sampling-processor.

Returns:

filterType

setFilterType

public void setFilterType(RetentionFilterType filterType)

name

public RetentionFilterCreateAttributes name(String name)

getName

public String getName()

The name of the retention filter.

Returns:

name

setName

public void setName(String name)

rate

public RetentionFilterCreateAttributes rate(Double rate)

getRate

public Double getRate()

Sample rate to apply to spans going through this retention filter. A value of 1.0 keeps all spans matching the query.

Returns:

rate

setRate

public void setRate(Double rate)

traceRate

public RetentionFilterCreateAttributes traceRate(Double traceRate)

getTraceRate

@Nullable
public Double getTraceRate()

Sample rate to apply to traces containing spans going through this retention filter. A value of 1.0 keeps all traces with spans matching the query.

Returns:

traceRate

setTraceRate

public void setTraceRate(Double traceRate)

putAdditionalProperty

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

RetentionFilterCreateAttributes

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