com.datadog.api.client.v2.model

Class SecretRuleDataAttributes

java.lang.Object

com.datadog.api.client.v2.model.SecretRuleDataAttributes

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

The attributes of a secret detection rule, including its pattern, priority, and validation configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_DEFAULT_INCLUDED_KEYWORDS
static String	JSON_PROPERTY_DESCRIPTION
static String	JSON_PROPERTY_LICENSE
static String	JSON_PROPERTY_MATCH_VALIDATION
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_PATTERN
static String	JSON_PROPERTY_PRIORITY
static String	JSON_PROPERTY_SDS_ID
static String	JSON_PROPERTY_VALIDATORS
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SecretRuleDataAttributes()

Method Summary

Modifier and Type	Method and Description
SecretRuleDataAttributes	addDefaultIncludedKeywordsItem(String defaultIncludedKeywordsItem)
SecretRuleDataAttributes	addValidatorsItem(String validatorsItem)
SecretRuleDataAttributes	defaultIncludedKeywords(List<String> defaultIncludedKeywords)
SecretRuleDataAttributes	description(String description)
boolean	equals(Object o) Return true if this SecretRuleDataAttributes 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.
List<String>	getDefaultIncludedKeywords() A list of keywords that are included by default when scanning for secrets matching this rule.
String	getDescription() A detailed explanation of what type of secret this rule detects.
String	getLicense() The license under which this secret rule is distributed.
SecretRuleDataAttributesMatchValidation	getMatchValidation() Configuration for validating whether a detected secret is active by making an HTTP request and inspecting the response.
String	getName() The unique name of the secret detection rule.
String	getPattern() The regular expression pattern used to identify potential secrets in source code or configuration.
String	getPriority() The priority level of this rule, used to rank findings when multiple rules match.
String	getSdsId() The identifier of the corresponding Sensitive Data Scanner rule, if one exists.
List<String>	getValidators() A list of validator identifiers used to further confirm a detected secret is genuine.
int	hashCode()
SecretRuleDataAttributes	license(String license)
SecretRuleDataAttributes	matchValidation(SecretRuleDataAttributesMatchValidation matchValidation)
SecretRuleDataAttributes	name(String name)
SecretRuleDataAttributes	pattern(String pattern)
SecretRuleDataAttributes	priority(String priority)
SecretRuleDataAttributes	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
SecretRuleDataAttributes	sdsId(String sdsId)
void	setDefaultIncludedKeywords(List<String> defaultIncludedKeywords)
void	setDescription(String description)
void	setLicense(String license)
void	setMatchValidation(SecretRuleDataAttributesMatchValidation matchValidation)
void	setName(String name)
void	setPattern(String pattern)
void	setPriority(String priority)
void	setSdsId(String sdsId)
void	setValidators(List<String> validators)
String	toString()
SecretRuleDataAttributes	validators(List<String> validators)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_DEFAULT_INCLUDED_KEYWORDS

public static final String JSON_PROPERTY_DEFAULT_INCLUDED_KEYWORDS

See Also:

Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

Constant Field Values

JSON_PROPERTY_LICENSE

public static final String JSON_PROPERTY_LICENSE

See Also:

Constant Field Values

JSON_PROPERTY_MATCH_VALIDATION

public static final String JSON_PROPERTY_MATCH_VALIDATION

See Also:

Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

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_SDS_ID

public static final String JSON_PROPERTY_SDS_ID

See Also:

Constant Field Values

JSON_PROPERTY_VALIDATORS

public static final String JSON_PROPERTY_VALIDATORS

See Also:

Constant Field Values

Constructor Detail

SecretRuleDataAttributes

public SecretRuleDataAttributes()

Method Detail

defaultIncludedKeywords

public SecretRuleDataAttributes defaultIncludedKeywords(List<String> defaultIncludedKeywords)

addDefaultIncludedKeywordsItem

public SecretRuleDataAttributes addDefaultIncludedKeywordsItem(String defaultIncludedKeywordsItem)

getDefaultIncludedKeywords

@Nullable
public List<String> getDefaultIncludedKeywords()

A list of keywords that are included by default when scanning for secrets matching this rule.

Returns:

defaultIncludedKeywords

setDefaultIncludedKeywords

public void setDefaultIncludedKeywords(List<String> defaultIncludedKeywords)

description

public SecretRuleDataAttributes description(String description)

getDescription

@Nullable
public String getDescription()

A detailed explanation of what type of secret this rule detects.

Returns:

description

setDescription

public void setDescription(String description)

license

public SecretRuleDataAttributes license(String license)

getLicense

@Nullable
public String getLicense()

The license under which this secret rule is distributed.

Returns:

license

setLicense

public void setLicense(String license)

matchValidation

public SecretRuleDataAttributes matchValidation(SecretRuleDataAttributesMatchValidation matchValidation)

getMatchValidation

@Nullable
public SecretRuleDataAttributesMatchValidation getMatchValidation()

Configuration for validating whether a detected secret is active by making an HTTP request and inspecting the response.

Returns:

matchValidation

setMatchValidation

public void setMatchValidation(SecretRuleDataAttributesMatchValidation matchValidation)

name

public SecretRuleDataAttributes name(String name)

getName

@Nullable
public String getName()

The unique name of the secret detection rule.

Returns:

name

setName

public void setName(String name)

pattern

public SecretRuleDataAttributes pattern(String pattern)

getPattern

@Nullable
public String getPattern()

The regular expression pattern used to identify potential secrets in source code or configuration.

Returns:

pattern

setPattern

public void setPattern(String pattern)

priority

public SecretRuleDataAttributes priority(String priority)

getPriority

@Nullable
public String getPriority()

The priority level of this rule, used to rank findings when multiple rules match.

Returns:

priority

setPriority

public void setPriority(String priority)

sdsId

public SecretRuleDataAttributes sdsId(String sdsId)

getSdsId

@Nullable
public String getSdsId()

The identifier of the corresponding Sensitive Data Scanner rule, if one exists.

Returns:

sdsId

setSdsId

public void setSdsId(String sdsId)

validators

public SecretRuleDataAttributes validators(List<String> validators)

addValidatorsItem

public SecretRuleDataAttributes addValidatorsItem(String validatorsItem)

getValidators

@Nullable
public List<String> getValidators()

A list of validator identifiers used to further confirm a detected secret is genuine.

Returns:

validators

setValidators

public void setValidators(List<String> validators)

putAdditionalProperty

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

SecretRuleDataAttributes

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