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

Class SyntheticsAPITestStep

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsAPITestStep

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

The Test step used in a Synthetic multi-step API test.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ALLOW_FAILURE
static final String	JSON_PROPERTY_ASSERTIONS
static final String	JSON_PROPERTY_EXIT_IF_SUCCEED
static final String	JSON_PROPERTY_EXTRACTED_VALUES
static final String	JSON_PROPERTY_EXTRACTED_VALUES_FROM_SCRIPT
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_IS_CRITICAL
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_REQUEST
static final String	JSON_PROPERTY_RETRY
static final String	JSON_PROPERTY_SUBTYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
SyntheticsAPITestStep()
SyntheticsAPITestStep(List<SyntheticsAssertion> assertions, String name, SyntheticsTestRequest request, SyntheticsAPITestStepSubtype subtype)

Method Summary

Modifier and Type	Method	Description
SyntheticsAPITestStep	addAssertionsItem(SyntheticsAssertion assertionsItem)
SyntheticsAPITestStep	addExtractedValuesItem(SyntheticsParsingOptions extractedValuesItem)
SyntheticsAPITestStep	allowFailure(Boolean allowFailure)
SyntheticsAPITestStep	assertions(List<SyntheticsAssertion> assertions)
boolean	equals(Object o)	Return true if this SyntheticsAPITestStep object is equal to o.
SyntheticsAPITestStep	exitIfSucceed(Boolean exitIfSucceed)
SyntheticsAPITestStep	extractedValues(List<SyntheticsParsingOptions> extractedValues)
SyntheticsAPITestStep	extractedValuesFromScript(String extractedValuesFromScript)
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
Boolean	getAllowFailure()	Determines whether or not to continue with test if this step fails.
List<SyntheticsAssertion>	getAssertions()	Array of assertions used for the test.
Boolean	getExitIfSucceed()	Determines whether or not to exit the test if the step succeeds.
List<SyntheticsParsingOptions>	getExtractedValues()	Array of values to parse and save as variables from the response.
String	getExtractedValuesFromScript()	Generate variables using JavaScript.
String	getId()	ID of the step.
Boolean	getIsCritical()	Determines whether or not to consider the entire test as failed if this step fails.
String	getName()	The name of the step.
SyntheticsTestRequest	getRequest()	Object describing the Synthetic test request.
SyntheticsTestOptionsRetry	getRetry()	Object describing the retry strategy to apply to a Synthetic test.
SyntheticsAPITestStepSubtype	getSubtype()	The subtype of the Synthetic multi-step API test step.
int	hashCode()
SyntheticsAPITestStep	isCritical(Boolean isCritical)
SyntheticsAPITestStep	name(String name)
SyntheticsAPITestStep	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
SyntheticsAPITestStep	request(SyntheticsTestRequest request)
SyntheticsAPITestStep	retry(SyntheticsTestOptionsRetry retry)
void	setAllowFailure(Boolean allowFailure)
void	setAssertions(List<SyntheticsAssertion> assertions)
void	setExitIfSucceed(Boolean exitIfSucceed)
void	setExtractedValues(List<SyntheticsParsingOptions> extractedValues)
void	setExtractedValuesFromScript(String extractedValuesFromScript)
void	setIsCritical(Boolean isCritical)
void	setName(String name)
void	setRequest(SyntheticsTestRequest request)
void	setRetry(SyntheticsTestOptionsRetry retry)
void	setSubtype(SyntheticsAPITestStepSubtype subtype)
SyntheticsAPITestStep	subtype(SyntheticsAPITestStepSubtype subtype)
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_ALLOW_FAILURE

public static final String JSON_PROPERTY_ALLOW_FAILURE

See Also:

• Constant Field Values

JSON_PROPERTY_ASSERTIONS

public static final String JSON_PROPERTY_ASSERTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_EXIT_IF_SUCCEED

public static final String JSON_PROPERTY_EXIT_IF_SUCCEED

See Also:

• Constant Field Values

JSON_PROPERTY_EXTRACTED_VALUES

public static final String JSON_PROPERTY_EXTRACTED_VALUES

See Also:

• Constant Field Values

JSON_PROPERTY_EXTRACTED_VALUES_FROM_SCRIPT

public static final String JSON_PROPERTY_EXTRACTED_VALUES_FROM_SCRIPT

See Also:

• Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

• Constant Field Values

JSON_PROPERTY_IS_CRITICAL

public static final String JSON_PROPERTY_IS_CRITICAL

See Also:

• Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_REQUEST

public static final String JSON_PROPERTY_REQUEST

See Also:

• Constant Field Values

JSON_PROPERTY_RETRY

public static final String JSON_PROPERTY_RETRY

See Also:

• Constant Field Values

JSON_PROPERTY_SUBTYPE

public static final String JSON_PROPERTY_SUBTYPE

See Also:

• Constant Field Values

Constructor Details

SyntheticsAPITestStep

public SyntheticsAPITestStep()

SyntheticsAPITestStep

public SyntheticsAPITestStep(List<SyntheticsAssertion> assertions,
 String name,
 SyntheticsTestRequest request,
 SyntheticsAPITestStepSubtype subtype)

Method Details

allowFailure

public SyntheticsAPITestStep allowFailure(Boolean allowFailure)

getAllowFailure

@Nullable
public Boolean getAllowFailure()

Determines whether or not to continue with test if this step fails.

Returns:

allowFailure

setAllowFailure

public void setAllowFailure(Boolean allowFailure)

assertions

public SyntheticsAPITestStep assertions(List<SyntheticsAssertion> assertions)

addAssertionsItem

public SyntheticsAPITestStep addAssertionsItem(SyntheticsAssertion assertionsItem)

getAssertions

public List<SyntheticsAssertion> getAssertions()

Array of assertions used for the test.

Returns:

assertions

setAssertions

public void setAssertions(List<SyntheticsAssertion> assertions)

exitIfSucceed

public SyntheticsAPITestStep exitIfSucceed(Boolean exitIfSucceed)

getExitIfSucceed

@Nullable
public Boolean getExitIfSucceed()

Determines whether or not to exit the test if the step succeeds.

Returns:

exitIfSucceed

setExitIfSucceed

public void setExitIfSucceed(Boolean exitIfSucceed)

extractedValues

public SyntheticsAPITestStep extractedValues(List<SyntheticsParsingOptions> extractedValues)

addExtractedValuesItem

public SyntheticsAPITestStep addExtractedValuesItem(SyntheticsParsingOptions extractedValuesItem)

getExtractedValues

@Nullable
public List<SyntheticsParsingOptions> getExtractedValues()

Array of values to parse and save as variables from the response.

Returns:

extractedValues

setExtractedValues

public void setExtractedValues(List<SyntheticsParsingOptions> extractedValues)

extractedValuesFromScript

public SyntheticsAPITestStep extractedValuesFromScript(String extractedValuesFromScript)

getExtractedValuesFromScript

@Nullable
public String getExtractedValuesFromScript()

Generate variables using JavaScript.

Returns:

extractedValuesFromScript

setExtractedValuesFromScript

public void setExtractedValuesFromScript(String extractedValuesFromScript)

getId

@Nullable
public String getId()

ID of the step.

Returns:

id

isCritical

public SyntheticsAPITestStep isCritical(Boolean isCritical)

getIsCritical

@Nullable
public Boolean getIsCritical()

Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allowFailure is true.

Returns:

isCritical

setIsCritical

public void setIsCritical(Boolean isCritical)

name

public SyntheticsAPITestStep name(String name)

getName

public String getName()

The name of the step.

Returns:

name

setName

public void setName(String name)

request

public SyntheticsAPITestStep request(SyntheticsTestRequest request)

getRequest

public SyntheticsTestRequest getRequest()

Object describing the Synthetic test request.

Returns:

request

setRequest

public void setRequest(SyntheticsTestRequest request)

retry

public SyntheticsAPITestStep retry(SyntheticsTestOptionsRetry retry)

getRetry

@Nullable
public SyntheticsTestOptionsRetry getRetry()

Object describing the retry strategy to apply to a Synthetic test.

Returns:

retry

setRetry

public void setRetry(SyntheticsTestOptionsRetry retry)

subtype

public SyntheticsAPITestStep subtype(SyntheticsAPITestStepSubtype subtype)

getSubtype

public SyntheticsAPITestStepSubtype getSubtype()

The subtype of the Synthetic multi-step API test step.

Returns:

subtype

setSubtype

public void setSubtype(SyntheticsAPITestStepSubtype subtype)

putAdditionalProperty

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

SyntheticsAPITestStep

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