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

Class SecurityMonitoringRuleUpdatePayload

java.lang.Object

com.datadog.api.client.v2.model.SecurityMonitoringRuleUpdatePayload

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

Update an existing rule.

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_COMPLIANCE_SIGNAL_OPTIONS
static final String	JSON_PROPERTY_CUSTOM_MESSAGE
static final String	JSON_PROPERTY_CUSTOM_NAME
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_VERSION
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
SecurityMonitoringRuleUpdatePayload()

Method Summary

Modifier and Type	Method	Description
SecurityMonitoringRuleUpdatePayload	addCalculatedFieldsItem(CalculatedField calculatedFieldsItem)
SecurityMonitoringRuleUpdatePayload	addCasesItem(SecurityMonitoringRuleCase casesItem)
SecurityMonitoringRuleUpdatePayload	addFiltersItem(SecurityMonitoringFilter filtersItem)
SecurityMonitoringRuleUpdatePayload	addGroupSignalsByItem(String groupSignalsByItem)
SecurityMonitoringRuleUpdatePayload	addQueriesItem(SecurityMonitoringRuleQuery queriesItem)
SecurityMonitoringRuleUpdatePayload	addReferenceTablesItem(SecurityMonitoringReferenceTable referenceTablesItem)
SecurityMonitoringRuleUpdatePayload	addTagsItem(String tagsItem)
SecurityMonitoringRuleUpdatePayload	addThirdPartyCasesItem(SecurityMonitoringThirdPartyRuleCase thirdPartyCasesItem)
SecurityMonitoringRuleUpdatePayload	calculatedFields(List<CalculatedField> calculatedFields)
SecurityMonitoringRuleUpdatePayload	cases(List<SecurityMonitoringRuleCase> cases)
SecurityMonitoringRuleUpdatePayload	complianceSignalOptions(CloudConfigurationRuleComplianceSignalOptions complianceSignalOptions)
SecurityMonitoringRuleUpdatePayload	customMessage(String customMessage)
SecurityMonitoringRuleUpdatePayload	customName(String customName)
boolean	equals(Object o)	Return true if this SecurityMonitoringRuleUpdatePayload object is equal to o.
SecurityMonitoringRuleUpdatePayload	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<SecurityMonitoringRuleCase>	getCases()	Cases for generating signals.
CloudConfigurationRuleComplianceSignalOptions	getComplianceSignalOptions()	How to generate compliance signals.
String	getCustomMessage()	Custom/Overridden Message for generated signals (used in case of Default rule update).
String	getCustomName()	Custom/Overridden name (used in case of Default rule update).
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()	Name of the rule.
SecurityMonitoringRuleOptions	getOptions()	Options.
List<SecurityMonitoringRuleQuery>	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<SecurityMonitoringThirdPartyRuleCase>	getThirdPartyCases()	Cases for generating signals from third-party rules.
Integer	getVersion()	The version of the rule being updated.
SecurityMonitoringRuleUpdatePayload	groupSignalsBy(List<String> groupSignalsBy)
SecurityMonitoringRuleUpdatePayload	hasExtendedTitle(Boolean hasExtendedTitle)
int	hashCode()
SecurityMonitoringRuleUpdatePayload	isEnabled(Boolean isEnabled)
SecurityMonitoringRuleUpdatePayload	message(String message)
SecurityMonitoringRuleUpdatePayload	name(String name)
SecurityMonitoringRuleUpdatePayload	options(SecurityMonitoringRuleOptions options)
SecurityMonitoringRuleUpdatePayload	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
SecurityMonitoringRuleUpdatePayload	queries(List<SecurityMonitoringRuleQuery> queries)
SecurityMonitoringRuleUpdatePayload	referenceTables(List<SecurityMonitoringReferenceTable> referenceTables)
SecurityMonitoringRuleUpdatePayload	schedulingOptions(SecurityMonitoringSchedulingOptions schedulingOptions)
void	setCalculatedFields(List<CalculatedField> calculatedFields)
void	setCases(List<SecurityMonitoringRuleCase> cases)
void	setComplianceSignalOptions(CloudConfigurationRuleComplianceSignalOptions complianceSignalOptions)
void	setCustomMessage(String customMessage)
void	setCustomName(String customName)
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<SecurityMonitoringRuleQuery> 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<SecurityMonitoringThirdPartyRuleCase> thirdPartyCases)
void	setVersion(Integer version)
SecurityMonitoringRuleUpdatePayload	tags(List<String> tags)
SecurityMonitoringRuleUpdatePayload	thirdPartyCases(List<SecurityMonitoringThirdPartyRuleCase> thirdPartyCases)
String	toString()
SecurityMonitoringRuleUpdatePayload	version(Integer version)

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_COMPLIANCE_SIGNAL_OPTIONS

public static final String JSON_PROPERTY_COMPLIANCE_SIGNAL_OPTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_CUSTOM_MESSAGE

public static final String JSON_PROPERTY_CUSTOM_MESSAGE

See Also:

• Constant Field Values

JSON_PROPERTY_CUSTOM_NAME

public static final String JSON_PROPERTY_CUSTOM_NAME

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_VERSION

public static final String JSON_PROPERTY_VERSION

See Also:

• Constant Field Values

Constructor Details

SecurityMonitoringRuleUpdatePayload

public SecurityMonitoringRuleUpdatePayload()

Method Details

calculatedFields

public SecurityMonitoringRuleUpdatePayload calculatedFields(List<CalculatedField> calculatedFields)

addCalculatedFieldsItem

public SecurityMonitoringRuleUpdatePayload 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 SecurityMonitoringRuleUpdatePayload cases(List<SecurityMonitoringRuleCase> cases)

addCasesItem

public SecurityMonitoringRuleUpdatePayload addCasesItem(SecurityMonitoringRuleCase casesItem)

getCases

@Nullable
public List<SecurityMonitoringRuleCase> getCases()

Cases for generating signals.

Returns:

cases

setCases

public void setCases(List<SecurityMonitoringRuleCase> cases)

complianceSignalOptions

public SecurityMonitoringRuleUpdatePayload complianceSignalOptions(CloudConfigurationRuleComplianceSignalOptions complianceSignalOptions)

getComplianceSignalOptions

@Nullable
public CloudConfigurationRuleComplianceSignalOptions getComplianceSignalOptions()

How to generate compliance signals. Useful for cloud_configuration rules only.

Returns:

complianceSignalOptions

setComplianceSignalOptions

public void setComplianceSignalOptions(CloudConfigurationRuleComplianceSignalOptions complianceSignalOptions)

customMessage

public SecurityMonitoringRuleUpdatePayload customMessage(String customMessage)

getCustomMessage

@Nullable
public String getCustomMessage()

Custom/Overridden Message for generated signals (used in case of Default rule update).

Returns:

customMessage

setCustomMessage

public void setCustomMessage(String customMessage)

customName

public SecurityMonitoringRuleUpdatePayload customName(String customName)

getCustomName

@Nullable
public String getCustomName()

Custom/Overridden name (used in case of Default rule update).

Returns:

customName

setCustomName

public void setCustomName(String customName)

filters

public SecurityMonitoringRuleUpdatePayload filters(List<SecurityMonitoringFilter> filters)

addFiltersItem

public SecurityMonitoringRuleUpdatePayload 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 SecurityMonitoringRuleUpdatePayload groupSignalsBy(List<String> groupSignalsBy)

addGroupSignalsByItem

public SecurityMonitoringRuleUpdatePayload 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 SecurityMonitoringRuleUpdatePayload 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 SecurityMonitoringRuleUpdatePayload isEnabled(Boolean isEnabled)

getIsEnabled

@Nullable
public Boolean getIsEnabled()

Whether the rule is enabled.

Returns:

isEnabled

setIsEnabled

public void setIsEnabled(Boolean isEnabled)

message

public SecurityMonitoringRuleUpdatePayload message(String message)

getMessage

@Nullable
public String getMessage()

Message for generated signals.

Returns:

message

setMessage

public void setMessage(String message)

name

public SecurityMonitoringRuleUpdatePayload name(String name)

getName

@Nullable
public String getName()

Name of the rule.

Returns:

name

setName

public void setName(String name)

options

public SecurityMonitoringRuleUpdatePayload options(SecurityMonitoringRuleOptions options)

getOptions

@Nullable
public SecurityMonitoringRuleOptions getOptions()

Options.

Returns:

options

setOptions

public void setOptions(SecurityMonitoringRuleOptions options)

queries

public SecurityMonitoringRuleUpdatePayload queries(List<SecurityMonitoringRuleQuery> queries)

addQueriesItem

public SecurityMonitoringRuleUpdatePayload addQueriesItem(SecurityMonitoringRuleQuery queriesItem)

getQueries

@Nullable
public List<SecurityMonitoringRuleQuery> getQueries()

Queries for selecting logs which are part of the rule.

Returns:

queries

setQueries

public void setQueries(List<SecurityMonitoringRuleQuery> queries)

referenceTables

public SecurityMonitoringRuleUpdatePayload referenceTables(List<SecurityMonitoringReferenceTable> referenceTables)

addReferenceTablesItem

public SecurityMonitoringRuleUpdatePayload 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 SecurityMonitoringRuleUpdatePayload 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 SecurityMonitoringRuleUpdatePayload tags(List<String> tags)

addTagsItem

public SecurityMonitoringRuleUpdatePayload addTagsItem(String tagsItem)

getTags

@Nullable
public List<String> getTags()

Tags for generated signals.

Returns:

tags

setTags

public void setTags(List<String> tags)

thirdPartyCases

public SecurityMonitoringRuleUpdatePayload thirdPartyCases(List<SecurityMonitoringThirdPartyRuleCase> thirdPartyCases)

addThirdPartyCasesItem

public SecurityMonitoringRuleUpdatePayload addThirdPartyCasesItem(SecurityMonitoringThirdPartyRuleCase thirdPartyCasesItem)

getThirdPartyCases

@Nullable
public List<SecurityMonitoringThirdPartyRuleCase> getThirdPartyCases()

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

Returns:

thirdPartyCases

setThirdPartyCases

public void setThirdPartyCases(List<SecurityMonitoringThirdPartyRuleCase> thirdPartyCases)

version

public SecurityMonitoringRuleUpdatePayload version(Integer version)

getVersion

@Nullable
public Integer getVersion()

The version of the rule being updated. maximum: 2147483647

Returns:

version

setVersion

public void setVersion(Integer version)

putAdditionalProperty

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

SecurityMonitoringRuleUpdatePayload

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