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

Class SecurityMonitoringStandardRuleTestPayload

java.lang.Object

com.datadog.api.client.v2.model.SecurityMonitoringStandardRuleTestPayload

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

The payload of a rule to test

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CALCULATED_FIELDS
static final String	JSON_PROPERTY_CASES
static final String	JSON_PROPERTY_FILTERS
static final String	JSON_PROPERTY_GROUP_SIGNALS_BY
static final String	JSON_PROPERTY_HAS_EXTENDED_TITLE
static final String	JSON_PROPERTY_IS_ENABLED
static final String	JSON_PROPERTY_MESSAGE
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_OPTIONS
static final String	JSON_PROPERTY_QUERIES
static final String	JSON_PROPERTY_REFERENCE_TABLES
static final String	JSON_PROPERTY_SCHEDULING_OPTIONS
static final String	JSON_PROPERTY_TAGS
static final String	JSON_PROPERTY_THIRD_PARTY_CASES
static final String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
SecurityMonitoringStandardRuleTestPayload()
SecurityMonitoringStandardRuleTestPayload(List<SecurityMonitoringRuleCaseCreate> cases, Boolean isEnabled, String message, String name, SecurityMonitoringRuleOptions options, List<SecurityMonitoringStandardRuleQuery> queries)

Method Summary

Modifier and Type	Method	Description
SecurityMonitoringStandardRuleTestPayload	addCalculatedFieldsItem(CalculatedField calculatedFieldsItem)
SecurityMonitoringStandardRuleTestPayload	addCasesItem(SecurityMonitoringRuleCaseCreate casesItem)
SecurityMonitoringStandardRuleTestPayload	addFiltersItem(SecurityMonitoringFilter filtersItem)
SecurityMonitoringStandardRuleTestPayload	addGroupSignalsByItem(String groupSignalsByItem)
SecurityMonitoringStandardRuleTestPayload	addQueriesItem(SecurityMonitoringStandardRuleQuery queriesItem)
SecurityMonitoringStandardRuleTestPayload	addReferenceTablesItem(SecurityMonitoringReferenceTable referenceTablesItem)
SecurityMonitoringStandardRuleTestPayload	addTagsItem(String tagsItem)
SecurityMonitoringStandardRuleTestPayload	addThirdPartyCasesItem(SecurityMonitoringThirdPartyRuleCaseCreate thirdPartyCasesItem)
SecurityMonitoringStandardRuleTestPayload	calculatedFields(List<CalculatedField> calculatedFields)
SecurityMonitoringStandardRuleTestPayload	cases(List<SecurityMonitoringRuleCaseCreate> cases)
boolean	equals(Object o)	Return true if this SecurityMonitoringStandardRuleTestPayload object is equal to o.
SecurityMonitoringStandardRuleTestPayload	filters(List<SecurityMonitoringFilter> filters)
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
List<CalculatedField>	getCalculatedFields()	Calculated fields.
List<SecurityMonitoringRuleCaseCreate>	getCases()	Cases for generating signals.
List<SecurityMonitoringFilter>	getFilters()	Additional queries to filter matched events before they are processed.
List<String>	getGroupSignalsBy()	Additional grouping to perform on top of the existing groups in the query section.
Boolean	getHasExtendedTitle()	Whether the notifications include the triggering group-by values in their title.
Boolean	getIsEnabled()	Whether the rule is enabled.
String	getMessage()	Message for generated signals.
String	getName()	The name of the rule.
SecurityMonitoringRuleOptions	getOptions()	Options.
List<SecurityMonitoringStandardRuleQuery>	getQueries()	Queries for selecting logs which are part of the rule.
List<SecurityMonitoringReferenceTable>	getReferenceTables()	Reference tables for the rule.
SecurityMonitoringSchedulingOptions	getSchedulingOptions()	Options for scheduled rules.
org.openapitools.jackson.nullable.JsonNullable<SecurityMonitoringSchedulingOptions>	getSchedulingOptions_JsonNullable()
List<String>	getTags()	Tags for generated signals.
List<SecurityMonitoringThirdPartyRuleCaseCreate>	getThirdPartyCases()	Cases for generating signals from third-party rules.
SecurityMonitoringRuleTypeTest	getType()	The rule type.
SecurityMonitoringStandardRuleTestPayload	groupSignalsBy(List<String> groupSignalsBy)
SecurityMonitoringStandardRuleTestPayload	hasExtendedTitle(Boolean hasExtendedTitle)
int	hashCode()
SecurityMonitoringStandardRuleTestPayload	isEnabled(Boolean isEnabled)
SecurityMonitoringStandardRuleTestPayload	message(String message)
SecurityMonitoringStandardRuleTestPayload	name(String name)
SecurityMonitoringStandardRuleTestPayload	options(SecurityMonitoringRuleOptions options)
SecurityMonitoringStandardRuleTestPayload	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
SecurityMonitoringStandardRuleTestPayload	queries(List<SecurityMonitoringStandardRuleQuery> queries)
SecurityMonitoringStandardRuleTestPayload	referenceTables(List<SecurityMonitoringReferenceTable> referenceTables)
SecurityMonitoringStandardRuleTestPayload	schedulingOptions(SecurityMonitoringSchedulingOptions schedulingOptions)
void	setCalculatedFields(List<CalculatedField> calculatedFields)
void	setCases(List<SecurityMonitoringRuleCaseCreate> cases)
void	setFilters(List<SecurityMonitoringFilter> filters)
void	setGroupSignalsBy(List<String> groupSignalsBy)
void	setHasExtendedTitle(Boolean hasExtendedTitle)
void	setIsEnabled(Boolean isEnabled)
void	setMessage(String message)
void	setName(String name)
void	setOptions(SecurityMonitoringRuleOptions options)
void	setQueries(List<SecurityMonitoringStandardRuleQuery> queries)
void	setReferenceTables(List<SecurityMonitoringReferenceTable> referenceTables)
void	setSchedulingOptions(SecurityMonitoringSchedulingOptions schedulingOptions)
void	setSchedulingOptions_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<SecurityMonitoringSchedulingOptions> schedulingOptions)
void	setTags(List<String> tags)
void	setThirdPartyCases(List<SecurityMonitoringThirdPartyRuleCaseCreate> thirdPartyCases)
void	setType(SecurityMonitoringRuleTypeTest type)
SecurityMonitoringStandardRuleTestPayload	tags(List<String> tags)
SecurityMonitoringStandardRuleTestPayload	thirdPartyCases(List<SecurityMonitoringThirdPartyRuleCaseCreate> thirdPartyCases)
String	toString()
SecurityMonitoringStandardRuleTestPayload	type(SecurityMonitoringRuleTypeTest type)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_CALCULATED_FIELDS

public static final String JSON_PROPERTY_CALCULATED_FIELDS

See Also:

• Constant Field Values

JSON_PROPERTY_CASES

public static final String JSON_PROPERTY_CASES

See Also:

• Constant Field Values

JSON_PROPERTY_FILTERS

public static final String JSON_PROPERTY_FILTERS

See Also:

• Constant Field Values

JSON_PROPERTY_GROUP_SIGNALS_BY

public static final String JSON_PROPERTY_GROUP_SIGNALS_BY

See Also:

• Constant Field Values

JSON_PROPERTY_HAS_EXTENDED_TITLE

public static final String JSON_PROPERTY_HAS_EXTENDED_TITLE

See Also:

• Constant Field Values

JSON_PROPERTY_IS_ENABLED

public static final String JSON_PROPERTY_IS_ENABLED

See Also:

• Constant Field Values

JSON_PROPERTY_MESSAGE

public static final String JSON_PROPERTY_MESSAGE

See Also:

• Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_OPTIONS

public static final String JSON_PROPERTY_OPTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_QUERIES

public static final String JSON_PROPERTY_QUERIES

See Also:

• Constant Field Values

JSON_PROPERTY_REFERENCE_TABLES

public static final String JSON_PROPERTY_REFERENCE_TABLES

See Also:

• Constant Field Values

JSON_PROPERTY_SCHEDULING_OPTIONS

public static final String JSON_PROPERTY_SCHEDULING_OPTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_TAGS

public static final String JSON_PROPERTY_TAGS

See Also:

• Constant Field Values

JSON_PROPERTY_THIRD_PARTY_CASES

public static final String JSON_PROPERTY_THIRD_PARTY_CASES

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

Constructor Details

SecurityMonitoringStandardRuleTestPayload

public SecurityMonitoringStandardRuleTestPayload()

SecurityMonitoringStandardRuleTestPayload

public SecurityMonitoringStandardRuleTestPayload(List<SecurityMonitoringRuleCaseCreate> cases,
 Boolean isEnabled,
 String message,
 String name,
 SecurityMonitoringRuleOptions options,
 List<SecurityMonitoringStandardRuleQuery> queries)

Method Details

calculatedFields

public SecurityMonitoringStandardRuleTestPayload calculatedFields(List<CalculatedField> calculatedFields)

addCalculatedFieldsItem

public SecurityMonitoringStandardRuleTestPayload addCalculatedFieldsItem(CalculatedField calculatedFieldsItem)

getCalculatedFields

@Nullable
public List<CalculatedField> getCalculatedFields()

Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.

Returns:

calculatedFields

setCalculatedFields

public void setCalculatedFields(List<CalculatedField> calculatedFields)

cases

public SecurityMonitoringStandardRuleTestPayload cases(List<SecurityMonitoringRuleCaseCreate> cases)

addCasesItem

public SecurityMonitoringStandardRuleTestPayload addCasesItem(SecurityMonitoringRuleCaseCreate casesItem)

getCases

public List<SecurityMonitoringRuleCaseCreate> getCases()

Cases for generating signals.

Returns:

cases

setCases

public void setCases(List<SecurityMonitoringRuleCaseCreate> cases)

filters

public SecurityMonitoringStandardRuleTestPayload filters(List<SecurityMonitoringFilter> filters)

addFiltersItem

public SecurityMonitoringStandardRuleTestPayload addFiltersItem(SecurityMonitoringFilter filtersItem)

getFilters

@Nullable
public List<SecurityMonitoringFilter> getFilters()

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.

Returns:

filters

setFilters

public void setFilters(List<SecurityMonitoringFilter> filters)

groupSignalsBy

public SecurityMonitoringStandardRuleTestPayload groupSignalsBy(List<String> groupSignalsBy)

addGroupSignalsByItem

public SecurityMonitoringStandardRuleTestPayload addGroupSignalsByItem(String groupSignalsByItem)

getGroupSignalsBy

@Nullable
public List<String> getGroupSignalsBy()

Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.

Returns:

groupSignalsBy

setGroupSignalsBy

public void setGroupSignalsBy(List<String> groupSignalsBy)

hasExtendedTitle

public SecurityMonitoringStandardRuleTestPayload hasExtendedTitle(Boolean hasExtendedTitle)

getHasExtendedTitle

@Nullable
public Boolean getHasExtendedTitle()

Whether the notifications include the triggering group-by values in their title.

Returns:

hasExtendedTitle

setHasExtendedTitle

public void setHasExtendedTitle(Boolean hasExtendedTitle)

isEnabled

public SecurityMonitoringStandardRuleTestPayload isEnabled(Boolean isEnabled)

getIsEnabled

public Boolean getIsEnabled()

Whether the rule is enabled.

Returns:

isEnabled

setIsEnabled

public void setIsEnabled(Boolean isEnabled)

message

public SecurityMonitoringStandardRuleTestPayload message(String message)

getMessage

public String getMessage()

Message for generated signals.

Returns:

message

setMessage

public void setMessage(String message)

name

public SecurityMonitoringStandardRuleTestPayload name(String name)

getName

public String getName()

The name of the rule.

Returns:

name

setName

public void setName(String name)

options

public SecurityMonitoringStandardRuleTestPayload options(SecurityMonitoringRuleOptions options)

getOptions

public SecurityMonitoringRuleOptions getOptions()

Options.

Returns:

options

setOptions

public void setOptions(SecurityMonitoringRuleOptions options)

queries

public SecurityMonitoringStandardRuleTestPayload queries(List<SecurityMonitoringStandardRuleQuery> queries)

addQueriesItem

public SecurityMonitoringStandardRuleTestPayload addQueriesItem(SecurityMonitoringStandardRuleQuery queriesItem)

getQueries

public List<SecurityMonitoringStandardRuleQuery> getQueries()

Queries for selecting logs which are part of the rule.

Returns:

queries

setQueries

public void setQueries(List<SecurityMonitoringStandardRuleQuery> queries)

referenceTables

public SecurityMonitoringStandardRuleTestPayload referenceTables(List<SecurityMonitoringReferenceTable> referenceTables)

addReferenceTablesItem

public SecurityMonitoringStandardRuleTestPayload addReferenceTablesItem(SecurityMonitoringReferenceTable referenceTablesItem)

getReferenceTables

@Nullable
public List<SecurityMonitoringReferenceTable> getReferenceTables()

Reference tables for the rule.

Returns:

referenceTables

setReferenceTables

public void setReferenceTables(List<SecurityMonitoringReferenceTable> referenceTables)

schedulingOptions

public SecurityMonitoringStandardRuleTestPayload schedulingOptions(SecurityMonitoringSchedulingOptions schedulingOptions)

getSchedulingOptions

@Nullable
public SecurityMonitoringSchedulingOptions getSchedulingOptions()

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

Returns:

schedulingOptions

getSchedulingOptions_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<SecurityMonitoringSchedulingOptions> getSchedulingOptions_JsonNullable()

setSchedulingOptions_JsonNullable

public void setSchedulingOptions_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<SecurityMonitoringSchedulingOptions> schedulingOptions)

setSchedulingOptions

public void setSchedulingOptions(SecurityMonitoringSchedulingOptions schedulingOptions)

tags

public SecurityMonitoringStandardRuleTestPayload tags(List<String> tags)

addTagsItem

public SecurityMonitoringStandardRuleTestPayload addTagsItem(String tagsItem)

getTags

@Nullable
public List<String> getTags()

Tags for generated signals.

Returns:

tags

setTags

public void setTags(List<String> tags)

thirdPartyCases

public SecurityMonitoringStandardRuleTestPayload thirdPartyCases(List<SecurityMonitoringThirdPartyRuleCaseCreate> thirdPartyCases)

addThirdPartyCasesItem

public SecurityMonitoringStandardRuleTestPayload addThirdPartyCasesItem(SecurityMonitoringThirdPartyRuleCaseCreate thirdPartyCasesItem)

getThirdPartyCases

@Nullable
public List<SecurityMonitoringThirdPartyRuleCaseCreate> getThirdPartyCases()

Cases for generating signals from third-party rules. Only available for third-party rules.

Returns:

thirdPartyCases

setThirdPartyCases

public void setThirdPartyCases(List<SecurityMonitoringThirdPartyRuleCaseCreate> thirdPartyCases)

type

public SecurityMonitoringStandardRuleTestPayload type(SecurityMonitoringRuleTypeTest type)

getType

@Nullable
public SecurityMonitoringRuleTypeTest getType()

The rule type.

Returns:

type

setType

public void setType(SecurityMonitoringRuleTypeTest type)

putAdditionalProperty

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

SecurityMonitoringStandardRuleTestPayload

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