Package com.datadog.api.client.v1.model

Class SyntheticsAPITestConfig

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsAPITestConfig

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

Configuration object for a Synthetic API test.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ASSERTIONS
static final String	JSON_PROPERTY_CONFIG_VARIABLES
static final String	JSON_PROPERTY_REQUEST
static final String	JSON_PROPERTY_STEPS
static final String	JSON_PROPERTY_VARIABLES_FROM_SCRIPT
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
SyntheticsAPITestConfig()

Method Summary

Modifier and Type	Method	Description
SyntheticsAPITestConfig	addAssertionsItem(SyntheticsAssertion assertionsItem)
SyntheticsAPITestConfig	addConfigVariablesItem(SyntheticsConfigVariable configVariablesItem)
SyntheticsAPITestConfig	addStepsItem(SyntheticsAPIStep stepsItem)
SyntheticsAPITestConfig	assertions(List<SyntheticsAssertion> assertions)
SyntheticsAPITestConfig	configVariables(List<SyntheticsConfigVariable> configVariables)
boolean	equals(Object o)	Return true if this SyntheticsAPITestConfig 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<SyntheticsAssertion>	getAssertions()	Array of assertions used for the test.
List<SyntheticsConfigVariable>	getConfigVariables()	Array of variables used for the test.
SyntheticsTestRequest	getRequest()	Object describing the Synthetic test request.
List<SyntheticsAPIStep>	getSteps()	When the test subtype is multi, the steps of the test.
String	getVariablesFromScript()	Variables defined from JavaScript code.
int	hashCode()
SyntheticsAPITestConfig	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
SyntheticsAPITestConfig	request(SyntheticsTestRequest request)
void	setAssertions(List<SyntheticsAssertion> assertions)
void	setConfigVariables(List<SyntheticsConfigVariable> configVariables)
void	setRequest(SyntheticsTestRequest request)
void	setSteps(List<SyntheticsAPIStep> steps)
void	setVariablesFromScript(String variablesFromScript)
SyntheticsAPITestConfig	steps(List<SyntheticsAPIStep> steps)
String	toString()
SyntheticsAPITestConfig	variablesFromScript(String variablesFromScript)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_ASSERTIONS

public static final String JSON_PROPERTY_ASSERTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_CONFIG_VARIABLES

public static final String JSON_PROPERTY_CONFIG_VARIABLES

See Also:

• Constant Field Values

JSON_PROPERTY_REQUEST

public static final String JSON_PROPERTY_REQUEST

See Also:

• Constant Field Values

JSON_PROPERTY_STEPS

public static final String JSON_PROPERTY_STEPS

See Also:

• Constant Field Values

JSON_PROPERTY_VARIABLES_FROM_SCRIPT

public static final String JSON_PROPERTY_VARIABLES_FROM_SCRIPT

See Also:

• Constant Field Values

Constructor Details

SyntheticsAPITestConfig

public SyntheticsAPITestConfig()

Method Details

assertions

public SyntheticsAPITestConfig assertions(List<SyntheticsAssertion> assertions)

addAssertionsItem

public SyntheticsAPITestConfig addAssertionsItem(SyntheticsAssertion assertionsItem)

getAssertions

@Nullable
public List<SyntheticsAssertion> getAssertions()

Array of assertions used for the test. Required for single API tests.

Returns:

assertions

setAssertions

public void setAssertions(List<SyntheticsAssertion> assertions)

configVariables

public SyntheticsAPITestConfig configVariables(List<SyntheticsConfigVariable> configVariables)

addConfigVariablesItem

public SyntheticsAPITestConfig addConfigVariablesItem(SyntheticsConfigVariable configVariablesItem)

getConfigVariables

@Nullable
public List<SyntheticsConfigVariable> getConfigVariables()

Array of variables used for the test.

Returns:

configVariables

setConfigVariables

public void setConfigVariables(List<SyntheticsConfigVariable> configVariables)

request

public SyntheticsAPITestConfig request(SyntheticsTestRequest request)

getRequest

@Nullable
public SyntheticsTestRequest getRequest()

Object describing the Synthetic test request.

Returns:

request

setRequest

public void setRequest(SyntheticsTestRequest request)

steps

public SyntheticsAPITestConfig steps(List<SyntheticsAPIStep> steps)

addStepsItem

public SyntheticsAPITestConfig addStepsItem(SyntheticsAPIStep stepsItem)

getSteps

@Nullable
public List<SyntheticsAPIStep> getSteps()

When the test subtype is multi, the steps of the test.

Returns:

steps

setSteps

public void setSteps(List<SyntheticsAPIStep> steps)

variablesFromScript

public SyntheticsAPITestConfig variablesFromScript(String variablesFromScript)

getVariablesFromScript

@Nullable
public String getVariablesFromScript()

Variables defined from JavaScript code.

Returns:

variablesFromScript

setVariablesFromScript

public void setVariablesFromScript(String variablesFromScript)

putAdditionalProperty

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

SyntheticsAPITestConfig

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