com.datadog.api.client.v2.model

Class AnalysisRuleResponse

java.lang.Object

com.datadog.api.client.v2.model.AnalysisRuleResponse

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

The result of applying a single static analysis rule to the analyzed source code.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ERRORS
static String	JSON_PROPERTY_EXECUTION_ERROR
static String	JSON_PROPERTY_EXECUTION_TIME_MS
static String	JSON_PROPERTY_IDENTIFIER
static String	JSON_PROPERTY_OUTPUT
static String	JSON_PROPERTY_VIOLATIONS
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
AnalysisRuleResponse()
AnalysisRuleResponse(List<String> errors, String executionError, Long executionTimeMs, String identifier, String output, List<AnalysisViolation> violations)

Method Summary

Modifier and Type	Method and Description
AnalysisRuleResponse	addErrorsItem(String errorsItem)
AnalysisRuleResponse	addViolationsItem(AnalysisViolation violationsItem)
boolean	equals(Object o) Return true if this AnalysisRuleResponse object is equal to o.
AnalysisRuleResponse	errors(List<String> errors)
AnalysisRuleResponse	executionError(String executionError)
AnalysisRuleResponse	executionTimeMs(Long executionTimeMs)
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
List<String>	getErrors() A list of error messages encountered while executing the rule.
String	getExecutionError() An error message if the rule execution failed, or null if execution succeeded.
Long	getExecutionTimeMs() The time taken to execute the rule, in milliseconds.
String	getIdentifier() The identifier of the rule that produced this response.
String	getOutput() The raw output produced by the rule engine during execution.
List<AnalysisViolation>	getViolations() The list of violations found by this rule.
int	hashCode()
AnalysisRuleResponse	identifier(String identifier)
AnalysisRuleResponse	output(String output)
AnalysisRuleResponse	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setErrors(List<String> errors)
void	setExecutionError(String executionError)
void	setExecutionTimeMs(Long executionTimeMs)
void	setIdentifier(String identifier)
void	setOutput(String output)
void	setViolations(List<AnalysisViolation> violations)
String	toString()
AnalysisRuleResponse	violations(List<AnalysisViolation> violations)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_ERRORS

public static final String JSON_PROPERTY_ERRORS

See Also:

Constant Field Values

JSON_PROPERTY_EXECUTION_ERROR

public static final String JSON_PROPERTY_EXECUTION_ERROR

See Also:

Constant Field Values

JSON_PROPERTY_EXECUTION_TIME_MS

public static final String JSON_PROPERTY_EXECUTION_TIME_MS

See Also:

Constant Field Values

JSON_PROPERTY_IDENTIFIER

public static final String JSON_PROPERTY_IDENTIFIER

See Also:

Constant Field Values

JSON_PROPERTY_OUTPUT

public static final String JSON_PROPERTY_OUTPUT

See Also:

Constant Field Values

JSON_PROPERTY_VIOLATIONS

public static final String JSON_PROPERTY_VIOLATIONS

See Also:

Constant Field Values

Constructor Detail

AnalysisRuleResponse

public AnalysisRuleResponse()

AnalysisRuleResponse

public AnalysisRuleResponse(List<String> errors,
                            String executionError,
                            Long executionTimeMs,
                            String identifier,
                            String output,
                            List<AnalysisViolation> violations)

Method Detail

errors

public AnalysisRuleResponse errors(List<String> errors)

addErrorsItem

public AnalysisRuleResponse addErrorsItem(String errorsItem)

getErrors

public List<String> getErrors()

A list of error messages encountered while executing the rule.

Returns:

errors

setErrors

public void setErrors(List<String> errors)

executionError

public AnalysisRuleResponse executionError(String executionError)

getExecutionError

@Nullable
public String getExecutionError()

An error message if the rule execution failed, or null if execution succeeded.

Returns:

executionError

setExecutionError

public void setExecutionError(String executionError)

executionTimeMs

public AnalysisRuleResponse executionTimeMs(Long executionTimeMs)

getExecutionTimeMs

public Long getExecutionTimeMs()

The time taken to execute the rule, in milliseconds.

Returns:

executionTimeMs

setExecutionTimeMs

public void setExecutionTimeMs(Long executionTimeMs)

identifier

public AnalysisRuleResponse identifier(String identifier)

getIdentifier

public String getIdentifier()

The identifier of the rule that produced this response.

Returns:

identifier

setIdentifier

public void setIdentifier(String identifier)

output

public AnalysisRuleResponse output(String output)

getOutput

public String getOutput()

The raw output produced by the rule engine during execution.

Returns:

output

setOutput

public void setOutput(String output)

violations

public AnalysisRuleResponse violations(List<AnalysisViolation> violations)

addViolationsItem

public AnalysisRuleResponse addViolationsItem(AnalysisViolation violationsItem)

getViolations

public List<AnalysisViolation> getViolations()

The list of violations found by this rule.

Returns:

violations

setViolations

public void setViolations(List<AnalysisViolation> violations)

putAdditionalProperty

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

AnalysisRuleResponse

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