com.datadog.api.client.v2.model

Class SecurityMonitoringRuleAnomalyDetectionOptions

java.lang.Object

com.datadog.api.client.v2.model.SecurityMonitoringRuleAnomalyDetectionOptions

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

Options on anomaly detection method.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_BUCKET_DURATION
static String	JSON_PROPERTY_DETECTION_TOLERANCE
static String	JSON_PROPERTY_INSTANTANEOUS_BASELINE
static String	JSON_PROPERTY_LEARNING_DURATION
static String	JSON_PROPERTY_LEARNING_PERIOD_BASELINE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SecurityMonitoringRuleAnomalyDetectionOptions()

Method Summary

Modifier and Type	Method and Description
SecurityMonitoringRuleAnomalyDetectionOptions	bucketDuration(SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration bucketDuration)
SecurityMonitoringRuleAnomalyDetectionOptions	detectionTolerance(SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance detectionTolerance)
boolean	equals(Object o) Return true if this SecurityMonitoringRuleAnomalyDetectionOptions 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.
SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration	getBucketDuration() Duration in seconds of the time buckets used to aggregate events matched by the rule.
SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance	getDetectionTolerance() An optional parameter that sets how permissive anomaly detection is.
Boolean	getInstantaneousBaseline() When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.
SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration	getLearningDuration() Learning duration in hours.
Long	getLearningPeriodBaseline() An optional override baseline to apply while the rule is in the learning period.
int	hashCode()
SecurityMonitoringRuleAnomalyDetectionOptions	instantaneousBaseline(Boolean instantaneousBaseline)
SecurityMonitoringRuleAnomalyDetectionOptions	learningDuration(SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration learningDuration)
SecurityMonitoringRuleAnomalyDetectionOptions	learningPeriodBaseline(Long learningPeriodBaseline)
SecurityMonitoringRuleAnomalyDetectionOptions	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setBucketDuration(SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration bucketDuration)
void	setDetectionTolerance(SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance detectionTolerance)
void	setInstantaneousBaseline(Boolean instantaneousBaseline)
void	setLearningDuration(SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration learningDuration)
void	setLearningPeriodBaseline(Long learningPeriodBaseline)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_BUCKET_DURATION

public static final String JSON_PROPERTY_BUCKET_DURATION

See Also:

Constant Field Values

JSON_PROPERTY_DETECTION_TOLERANCE

public static final String JSON_PROPERTY_DETECTION_TOLERANCE

See Also:

Constant Field Values

JSON_PROPERTY_INSTANTANEOUS_BASELINE

public static final String JSON_PROPERTY_INSTANTANEOUS_BASELINE

See Also:

Constant Field Values

JSON_PROPERTY_LEARNING_DURATION

public static final String JSON_PROPERTY_LEARNING_DURATION

See Also:

Constant Field Values

JSON_PROPERTY_LEARNING_PERIOD_BASELINE

public static final String JSON_PROPERTY_LEARNING_PERIOD_BASELINE

See Also:

Constant Field Values

Constructor Detail

SecurityMonitoringRuleAnomalyDetectionOptions

public SecurityMonitoringRuleAnomalyDetectionOptions()

Method Detail

bucketDuration

public SecurityMonitoringRuleAnomalyDetectionOptions bucketDuration(SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration bucketDuration)

getBucketDuration

@Nullable
public SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration getBucketDuration()

Duration in seconds of the time buckets used to aggregate events matched by the rule. Must be greater than or equal to 300.

Returns:

bucketDuration

setBucketDuration

public void setBucketDuration(SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration bucketDuration)

detectionTolerance

public SecurityMonitoringRuleAnomalyDetectionOptions detectionTolerance(SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance detectionTolerance)

getDetectionTolerance

@Nullable
public SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance getDetectionTolerance()

An optional parameter that sets how permissive anomaly detection is. Higher values require higher deviations before triggering a signal.

Returns:

detectionTolerance

setDetectionTolerance

public void setDetectionTolerance(SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance detectionTolerance)

instantaneousBaseline

public SecurityMonitoringRuleAnomalyDetectionOptions instantaneousBaseline(Boolean instantaneousBaseline)

getInstantaneousBaseline

@Nullable
public Boolean getInstantaneousBaseline()

When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.

Returns:

instantaneousBaseline

setInstantaneousBaseline

public void setInstantaneousBaseline(Boolean instantaneousBaseline)

learningDuration

public SecurityMonitoringRuleAnomalyDetectionOptions learningDuration(SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration learningDuration)

getLearningDuration

@Nullable
public SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration getLearningDuration()

Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating.

Returns:

learningDuration

setLearningDuration

public void setLearningDuration(SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration learningDuration)

learningPeriodBaseline

public SecurityMonitoringRuleAnomalyDetectionOptions learningPeriodBaseline(Long learningPeriodBaseline)

getLearningPeriodBaseline

@Nullable
public Long getLearningPeriodBaseline()

An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0. minimum: 0

Returns:

learningPeriodBaseline

setLearningPeriodBaseline

public void setLearningPeriodBaseline(Long learningPeriodBaseline)

putAdditionalProperty

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

SecurityMonitoringRuleAnomalyDetectionOptions

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