Package com.datadog.api.client.v2.model

Class SecurityMonitoringRuleOptions

java.lang.Object

com.datadog.api.client.v2.model.SecurityMonitoringRuleOptions

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

Options.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ANOMALY_DETECTION_OPTIONS
static final String	JSON_PROPERTY_COMPLIANCE_RULE_OPTIONS
static final String	JSON_PROPERTY_DECREASE_CRITICALITY_BASED_ON_ENV
static final String	JSON_PROPERTY_DETECTION_METHOD
static final String	JSON_PROPERTY_EVALUATION_WINDOW
static final String	JSON_PROPERTY_HARDCODED_EVALUATOR_TYPE
static final String	JSON_PROPERTY_IMPOSSIBLE_TRAVEL_OPTIONS
static final String	JSON_PROPERTY_KEEP_ALIVE
static final String	JSON_PROPERTY_MAX_SIGNAL_DURATION
static final String	JSON_PROPERTY_NEW_VALUE_OPTIONS
static final String	JSON_PROPERTY_SEQUENCE_DETECTION_OPTIONS
static final String	JSON_PROPERTY_THIRD_PARTY_RULE_OPTIONS
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
SecurityMonitoringRuleOptions()

Method Summary

Modifier and Type	Method	Description
SecurityMonitoringRuleOptions	anomalyDetectionOptions(SecurityMonitoringRuleAnomalyDetectionOptions anomalyDetectionOptions)
SecurityMonitoringRuleOptions	complianceRuleOptions(CloudConfigurationComplianceRuleOptions complianceRuleOptions)
SecurityMonitoringRuleOptions	decreaseCriticalityBasedOnEnv(Boolean decreaseCriticalityBasedOnEnv)
SecurityMonitoringRuleOptions	detectionMethod(SecurityMonitoringRuleDetectionMethod detectionMethod)
boolean	equals(Object o)	Return true if this SecurityMonitoringRuleOptions object is equal to o.
SecurityMonitoringRuleOptions	evaluationWindow(SecurityMonitoringRuleEvaluationWindow evaluationWindow)
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
SecurityMonitoringRuleAnomalyDetectionOptions	getAnomalyDetectionOptions()	Options on anomaly detection method.
CloudConfigurationComplianceRuleOptions	getComplianceRuleOptions()	Options for cloud_configuration rules.
Boolean	getDecreaseCriticalityBasedOnEnv()	If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.
SecurityMonitoringRuleDetectionMethod	getDetectionMethod()	The detection method.
SecurityMonitoringRuleEvaluationWindow	getEvaluationWindow()	A time window is specified to match when at least one of the cases matches true.
SecurityMonitoringRuleHardcodedEvaluatorType	getHardcodedEvaluatorType()	Hardcoded evaluator type.
SecurityMonitoringRuleImpossibleTravelOptions	getImpossibleTravelOptions()	Options on impossible travel detection method.
SecurityMonitoringRuleKeepAlive	getKeepAlive()	Once a signal is generated, the signal will remain "open" if a case is matched at least once within this keep alive window.
SecurityMonitoringRuleMaxSignalDuration	getMaxSignalDuration()	A signal will "close" regardless of the query being matched once the time exceeds the maximum duration.
SecurityMonitoringRuleNewValueOptions	getNewValueOptions()	Options on new value detection method.
SecurityMonitoringRuleSequenceDetectionOptions	getSequenceDetectionOptions()	Options on sequence detection method.
SecurityMonitoringRuleThirdPartyOptions	getThirdPartyRuleOptions()	Options on third party detection method.
SecurityMonitoringRuleOptions	hardcodedEvaluatorType(SecurityMonitoringRuleHardcodedEvaluatorType hardcodedEvaluatorType)
int	hashCode()
SecurityMonitoringRuleOptions	impossibleTravelOptions(SecurityMonitoringRuleImpossibleTravelOptions impossibleTravelOptions)
SecurityMonitoringRuleOptions	keepAlive(SecurityMonitoringRuleKeepAlive keepAlive)
SecurityMonitoringRuleOptions	maxSignalDuration(SecurityMonitoringRuleMaxSignalDuration maxSignalDuration)
SecurityMonitoringRuleOptions	newValueOptions(SecurityMonitoringRuleNewValueOptions newValueOptions)
SecurityMonitoringRuleOptions	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
SecurityMonitoringRuleOptions	sequenceDetectionOptions(SecurityMonitoringRuleSequenceDetectionOptions sequenceDetectionOptions)
void	setAnomalyDetectionOptions(SecurityMonitoringRuleAnomalyDetectionOptions anomalyDetectionOptions)
void	setComplianceRuleOptions(CloudConfigurationComplianceRuleOptions complianceRuleOptions)
void	setDecreaseCriticalityBasedOnEnv(Boolean decreaseCriticalityBasedOnEnv)
void	setDetectionMethod(SecurityMonitoringRuleDetectionMethod detectionMethod)
void	setEvaluationWindow(SecurityMonitoringRuleEvaluationWindow evaluationWindow)
void	setHardcodedEvaluatorType(SecurityMonitoringRuleHardcodedEvaluatorType hardcodedEvaluatorType)
void	setImpossibleTravelOptions(SecurityMonitoringRuleImpossibleTravelOptions impossibleTravelOptions)
void	setKeepAlive(SecurityMonitoringRuleKeepAlive keepAlive)
void	setMaxSignalDuration(SecurityMonitoringRuleMaxSignalDuration maxSignalDuration)
void	setNewValueOptions(SecurityMonitoringRuleNewValueOptions newValueOptions)
void	setSequenceDetectionOptions(SecurityMonitoringRuleSequenceDetectionOptions sequenceDetectionOptions)
void	setThirdPartyRuleOptions(SecurityMonitoringRuleThirdPartyOptions thirdPartyRuleOptions)
SecurityMonitoringRuleOptions	thirdPartyRuleOptions(SecurityMonitoringRuleThirdPartyOptions thirdPartyRuleOptions)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_ANOMALY_DETECTION_OPTIONS

public static final String JSON_PROPERTY_ANOMALY_DETECTION_OPTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_COMPLIANCE_RULE_OPTIONS

public static final String JSON_PROPERTY_COMPLIANCE_RULE_OPTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_DECREASE_CRITICALITY_BASED_ON_ENV

public static final String JSON_PROPERTY_DECREASE_CRITICALITY_BASED_ON_ENV

See Also:

• Constant Field Values

JSON_PROPERTY_DETECTION_METHOD

public static final String JSON_PROPERTY_DETECTION_METHOD

See Also:

• Constant Field Values

JSON_PROPERTY_EVALUATION_WINDOW

public static final String JSON_PROPERTY_EVALUATION_WINDOW

See Also:

• Constant Field Values

JSON_PROPERTY_HARDCODED_EVALUATOR_TYPE

public static final String JSON_PROPERTY_HARDCODED_EVALUATOR_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_IMPOSSIBLE_TRAVEL_OPTIONS

public static final String JSON_PROPERTY_IMPOSSIBLE_TRAVEL_OPTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_KEEP_ALIVE

public static final String JSON_PROPERTY_KEEP_ALIVE

See Also:

• Constant Field Values

JSON_PROPERTY_MAX_SIGNAL_DURATION

public static final String JSON_PROPERTY_MAX_SIGNAL_DURATION

See Also:

• Constant Field Values

JSON_PROPERTY_NEW_VALUE_OPTIONS

public static final String JSON_PROPERTY_NEW_VALUE_OPTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_SEQUENCE_DETECTION_OPTIONS

public static final String JSON_PROPERTY_SEQUENCE_DETECTION_OPTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_THIRD_PARTY_RULE_OPTIONS

public static final String JSON_PROPERTY_THIRD_PARTY_RULE_OPTIONS

See Also:

• Constant Field Values

Constructor Details

SecurityMonitoringRuleOptions

public SecurityMonitoringRuleOptions()

Method Details

anomalyDetectionOptions

public SecurityMonitoringRuleOptions anomalyDetectionOptions(SecurityMonitoringRuleAnomalyDetectionOptions anomalyDetectionOptions)

getAnomalyDetectionOptions

@Nullable
public SecurityMonitoringRuleAnomalyDetectionOptions getAnomalyDetectionOptions()

Options on anomaly detection method.

Returns:

anomalyDetectionOptions

setAnomalyDetectionOptions

public void setAnomalyDetectionOptions(SecurityMonitoringRuleAnomalyDetectionOptions anomalyDetectionOptions)

complianceRuleOptions

public SecurityMonitoringRuleOptions complianceRuleOptions(CloudConfigurationComplianceRuleOptions complianceRuleOptions)

getComplianceRuleOptions

@Nullable
public CloudConfigurationComplianceRuleOptions getComplianceRuleOptions()

Options for cloud_configuration rules. Fields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

Returns:

complianceRuleOptions

setComplianceRuleOptions

public void setComplianceRuleOptions(CloudConfigurationComplianceRuleOptions complianceRuleOptions)

decreaseCriticalityBasedOnEnv

public SecurityMonitoringRuleOptions decreaseCriticalityBasedOnEnv(Boolean decreaseCriticalityBasedOnEnv)

getDecreaseCriticalityBasedOnEnv

@Nullable
public Boolean getDecreaseCriticalityBasedOnEnv()

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise. The severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO. The decrement is applied when the environment tag of the signal starts with staging, test or dev.

Returns:

decreaseCriticalityBasedOnEnv

setDecreaseCriticalityBasedOnEnv

public void setDecreaseCriticalityBasedOnEnv(Boolean decreaseCriticalityBasedOnEnv)

detectionMethod

public SecurityMonitoringRuleOptions detectionMethod(SecurityMonitoringRuleDetectionMethod detectionMethod)

getDetectionMethod

@Nullable
public SecurityMonitoringRuleDetectionMethod getDetectionMethod()

The detection method.

Returns:

detectionMethod

setDetectionMethod

public void setDetectionMethod(SecurityMonitoringRuleDetectionMethod detectionMethod)

evaluationWindow

public SecurityMonitoringRuleOptions evaluationWindow(SecurityMonitoringRuleEvaluationWindow evaluationWindow)

getEvaluationWindow

@Nullable
public SecurityMonitoringRuleEvaluationWindow getEvaluationWindow()

A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. For third party detection method, this field is not used.

Returns:

evaluationWindow

setEvaluationWindow

public void setEvaluationWindow(SecurityMonitoringRuleEvaluationWindow evaluationWindow)

hardcodedEvaluatorType

public SecurityMonitoringRuleOptions hardcodedEvaluatorType(SecurityMonitoringRuleHardcodedEvaluatorType hardcodedEvaluatorType)

getHardcodedEvaluatorType

@Nullable
public SecurityMonitoringRuleHardcodedEvaluatorType getHardcodedEvaluatorType()

Hardcoded evaluator type.

Returns:

hardcodedEvaluatorType

setHardcodedEvaluatorType

public void setHardcodedEvaluatorType(SecurityMonitoringRuleHardcodedEvaluatorType hardcodedEvaluatorType)

impossibleTravelOptions

public SecurityMonitoringRuleOptions impossibleTravelOptions(SecurityMonitoringRuleImpossibleTravelOptions impossibleTravelOptions)

getImpossibleTravelOptions

@Nullable
public SecurityMonitoringRuleImpossibleTravelOptions getImpossibleTravelOptions()

Options on impossible travel detection method.

Returns:

impossibleTravelOptions

setImpossibleTravelOptions

public void setImpossibleTravelOptions(SecurityMonitoringRuleImpossibleTravelOptions impossibleTravelOptions)

keepAlive

public SecurityMonitoringRuleOptions keepAlive(SecurityMonitoringRuleKeepAlive keepAlive)

getKeepAlive

@Nullable
public SecurityMonitoringRuleKeepAlive getKeepAlive()

Once a signal is generated, the signal will remain "open" if a case is matched at least once within this keep alive window. For third party detection method, this field is not used.

Returns:

keepAlive

setKeepAlive

public void setKeepAlive(SecurityMonitoringRuleKeepAlive keepAlive)

maxSignalDuration

public SecurityMonitoringRuleOptions maxSignalDuration(SecurityMonitoringRuleMaxSignalDuration maxSignalDuration)

getMaxSignalDuration

@Nullable
public SecurityMonitoringRuleMaxSignalDuration getMaxSignalDuration()

A signal will "close" regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp.

Returns:

maxSignalDuration

setMaxSignalDuration

public void setMaxSignalDuration(SecurityMonitoringRuleMaxSignalDuration maxSignalDuration)

newValueOptions

public SecurityMonitoringRuleOptions newValueOptions(SecurityMonitoringRuleNewValueOptions newValueOptions)

getNewValueOptions

@Nullable
public SecurityMonitoringRuleNewValueOptions getNewValueOptions()

Options on new value detection method.

Returns:

newValueOptions

setNewValueOptions

public void setNewValueOptions(SecurityMonitoringRuleNewValueOptions newValueOptions)

sequenceDetectionOptions

public SecurityMonitoringRuleOptions sequenceDetectionOptions(SecurityMonitoringRuleSequenceDetectionOptions sequenceDetectionOptions)

getSequenceDetectionOptions

@Nullable
public SecurityMonitoringRuleSequenceDetectionOptions getSequenceDetectionOptions()

Options on sequence detection method.

Returns:

sequenceDetectionOptions

setSequenceDetectionOptions

public void setSequenceDetectionOptions(SecurityMonitoringRuleSequenceDetectionOptions sequenceDetectionOptions)

thirdPartyRuleOptions

public SecurityMonitoringRuleOptions thirdPartyRuleOptions(SecurityMonitoringRuleThirdPartyOptions thirdPartyRuleOptions)

getThirdPartyRuleOptions

@Nullable
public SecurityMonitoringRuleThirdPartyOptions getThirdPartyRuleOptions()

Options on third party detection method.

Returns:

thirdPartyRuleOptions

setThirdPartyRuleOptions

public void setThirdPartyRuleOptions(SecurityMonitoringRuleThirdPartyOptions thirdPartyRuleOptions)

putAdditionalProperty

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

SecurityMonitoringRuleOptions

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