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

Class SensitiveDataScannerRuleAttributes

java.lang.Object

com.datadog.api.client.v2.model.SensitiveDataScannerRuleAttributes

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

Attributes of the Sensitive Data Scanner rule.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_EXCLUDED_NAMESPACES
static final String	JSON_PROPERTY_INCLUDED_KEYWORD_CONFIGURATION
static final String	JSON_PROPERTY_IS_ENABLED
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_NAMESPACES
static final String	JSON_PROPERTY_PATTERN
static final String	JSON_PROPERTY_PRIORITY
static final String	JSON_PROPERTY_SUPPRESSIONS
static final String	JSON_PROPERTY_TAGS
static final String	JSON_PROPERTY_TEXT_REPLACEMENT
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
SensitiveDataScannerRuleAttributes()

Method Summary

Modifier and Type	Method	Description
SensitiveDataScannerRuleAttributes	addExcludedNamespacesItem(String excludedNamespacesItem)
SensitiveDataScannerRuleAttributes	addNamespacesItem(String namespacesItem)
SensitiveDataScannerRuleAttributes	addTagsItem(String tagsItem)
SensitiveDataScannerRuleAttributes	description(String description)
boolean	equals(Object o)	Return true if this SensitiveDataScannerRuleAttributes object is equal to o.
SensitiveDataScannerRuleAttributes	excludedNamespaces(List<String> excludedNamespaces)
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
String	getDescription()	Description of the rule.
List<String>	getExcludedNamespaces()	Attributes excluded from the scan.
SensitiveDataScannerIncludedKeywordConfiguration	getIncludedKeywordConfiguration()	Object defining a set of keywords and a number of characters that help reduce noise.
Boolean	getIsEnabled()	Whether or not the rule is enabled.
String	getName()	Name of the rule.
List<String>	getNamespaces()	Attributes included in the scan.
String	getPattern()	Not included if there is a relationship to a standard pattern.
Long	getPriority()	Integer from 1 (high) to 5 (low) indicating rule issue severity.
SensitiveDataScannerSuppressions	getSuppressions()	Object describing the suppressions for a rule.
List<String>	getTags()	List of tags.
SensitiveDataScannerTextReplacement	getTextReplacement()	Object describing how the scanned event will be replaced.
int	hashCode()
SensitiveDataScannerRuleAttributes	includedKeywordConfiguration(SensitiveDataScannerIncludedKeywordConfiguration includedKeywordConfiguration)
SensitiveDataScannerRuleAttributes	isEnabled(Boolean isEnabled)
SensitiveDataScannerRuleAttributes	name(String name)
SensitiveDataScannerRuleAttributes	namespaces(List<String> namespaces)
SensitiveDataScannerRuleAttributes	pattern(String pattern)
SensitiveDataScannerRuleAttributes	priority(Long priority)
SensitiveDataScannerRuleAttributes	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setDescription(String description)
void	setExcludedNamespaces(List<String> excludedNamespaces)
void	setIncludedKeywordConfiguration(SensitiveDataScannerIncludedKeywordConfiguration includedKeywordConfiguration)
void	setIsEnabled(Boolean isEnabled)
void	setName(String name)
void	setNamespaces(List<String> namespaces)
void	setPattern(String pattern)
void	setPriority(Long priority)
void	setSuppressions(SensitiveDataScannerSuppressions suppressions)
void	setTags(List<String> tags)
void	setTextReplacement(SensitiveDataScannerTextReplacement textReplacement)
SensitiveDataScannerRuleAttributes	suppressions(SensitiveDataScannerSuppressions suppressions)
SensitiveDataScannerRuleAttributes	tags(List<String> tags)
SensitiveDataScannerRuleAttributes	textReplacement(SensitiveDataScannerTextReplacement textReplacement)
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_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_EXCLUDED_NAMESPACES

public static final String JSON_PROPERTY_EXCLUDED_NAMESPACES

See Also:

• Constant Field Values

JSON_PROPERTY_INCLUDED_KEYWORD_CONFIGURATION

public static final String JSON_PROPERTY_INCLUDED_KEYWORD_CONFIGURATION

See Also:

• Constant Field Values

JSON_PROPERTY_IS_ENABLED

public static final String JSON_PROPERTY_IS_ENABLED

See Also:

• Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_NAMESPACES

public static final String JSON_PROPERTY_NAMESPACES

See Also:

• Constant Field Values

JSON_PROPERTY_PATTERN

public static final String JSON_PROPERTY_PATTERN

See Also:

• Constant Field Values

JSON_PROPERTY_PRIORITY

public static final String JSON_PROPERTY_PRIORITY

See Also:

• Constant Field Values

JSON_PROPERTY_SUPPRESSIONS

public static final String JSON_PROPERTY_SUPPRESSIONS

See Also:

• Constant Field Values

JSON_PROPERTY_TAGS

public static final String JSON_PROPERTY_TAGS

See Also:

• Constant Field Values

JSON_PROPERTY_TEXT_REPLACEMENT

public static final String JSON_PROPERTY_TEXT_REPLACEMENT

See Also:

• Constant Field Values

Constructor Details

SensitiveDataScannerRuleAttributes

public SensitiveDataScannerRuleAttributes()

Method Details

description

public SensitiveDataScannerRuleAttributes description(String description)

getDescription

@Nullable
public String getDescription()

Description of the rule.

Returns:

description

setDescription

public void setDescription(String description)

excludedNamespaces

public SensitiveDataScannerRuleAttributes excludedNamespaces(List<String> excludedNamespaces)

addExcludedNamespacesItem

public SensitiveDataScannerRuleAttributes addExcludedNamespacesItem(String excludedNamespacesItem)

getExcludedNamespaces

@Nullable
public List<String> getExcludedNamespaces()

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

Returns:

excludedNamespaces

setExcludedNamespaces

public void setExcludedNamespaces(List<String> excludedNamespaces)

includedKeywordConfiguration

public SensitiveDataScannerRuleAttributes includedKeywordConfiguration(SensitiveDataScannerIncludedKeywordConfiguration includedKeywordConfiguration)

getIncludedKeywordConfiguration

@Nullable
public SensitiveDataScannerIncludedKeywordConfiguration getIncludedKeywordConfiguration()

Object defining a set of keywords and a number of characters that help reduce noise. You can provide a list of keywords you would like to check within a defined proximity of the matching pattern. If any of the keywords are found within the proximity check, the match is kept. If none are found, the match is discarded.

Returns:

includedKeywordConfiguration

setIncludedKeywordConfiguration

public void setIncludedKeywordConfiguration(SensitiveDataScannerIncludedKeywordConfiguration includedKeywordConfiguration)

isEnabled

public SensitiveDataScannerRuleAttributes isEnabled(Boolean isEnabled)

getIsEnabled

@Nullable
public Boolean getIsEnabled()

Whether or not the rule is enabled.

Returns:

isEnabled

setIsEnabled

public void setIsEnabled(Boolean isEnabled)

name

public SensitiveDataScannerRuleAttributes name(String name)

getName

@Nullable
public String getName()

Name of the rule.

Returns:

name

setName

public void setName(String name)

namespaces

public SensitiveDataScannerRuleAttributes namespaces(List<String> namespaces)

addNamespacesItem

public SensitiveDataScannerRuleAttributes addNamespacesItem(String namespacesItem)

getNamespaces

@Nullable
public List<String> getNamespaces()

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned. If both are missing the whole event is scanned.

Returns:

namespaces

setNamespaces

public void setNamespaces(List<String> namespaces)

pattern

public SensitiveDataScannerRuleAttributes pattern(String pattern)

getPattern

@Nullable
public String getPattern()

Not included if there is a relationship to a standard pattern.

Returns:

pattern

setPattern

public void setPattern(String pattern)

priority

public SensitiveDataScannerRuleAttributes priority(Long priority)

getPriority

@Nullable
public Long getPriority()

Integer from 1 (high) to 5 (low) indicating rule issue severity. minimum: 1 maximum: 5

Returns:

priority

setPriority

public void setPriority(Long priority)

suppressions

public SensitiveDataScannerRuleAttributes suppressions(SensitiveDataScannerSuppressions suppressions)

getSuppressions

@Nullable
public SensitiveDataScannerSuppressions getSuppressions()

Object describing the suppressions for a rule. There are three types of suppressions, starts_with, ends_with, and exact_match. Suppressed matches are not obfuscated, counted in metrics, or displayed in the Findings page.

Returns:

suppressions

setSuppressions

public void setSuppressions(SensitiveDataScannerSuppressions suppressions)

tags

public SensitiveDataScannerRuleAttributes tags(List<String> tags)

addTagsItem

public SensitiveDataScannerRuleAttributes addTagsItem(String tagsItem)

getTags

@Nullable
public List<String> getTags()

List of tags.

Returns:

tags

setTags

public void setTags(List<String> tags)

textReplacement

public SensitiveDataScannerRuleAttributes textReplacement(SensitiveDataScannerTextReplacement textReplacement)

getTextReplacement

@Nullable
public SensitiveDataScannerTextReplacement getTextReplacement()

Object describing how the scanned event will be replaced.

Returns:

textReplacement

setTextReplacement

public void setTextReplacement(SensitiveDataScannerTextReplacement textReplacement)

putAdditionalProperty

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

SensitiveDataScannerRuleAttributes

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