com.datadog.api.client.v1.model

Class SyntheticsAPIStep

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsAPIStep

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

The steps used in a Synthetic multistep API test.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SyntheticsAPIStep()
SyntheticsAPIStep(List<SyntheticsAssertion> assertions, String name, SyntheticsTestRequest request, SyntheticsAPIStepSubtype subtype)

Method Summary

Modifier and Type	Method and Description
SyntheticsAPIStep	addAssertionsItem(SyntheticsAssertion assertionsItem)
SyntheticsAPIStep	addExtractedValuesItem(SyntheticsParsingOptions extractedValuesItem)
SyntheticsAPIStep	allowFailure(Boolean allowFailure)
SyntheticsAPIStep	assertions(List<SyntheticsAssertion> assertions)
boolean	equals(Object o) Return true if this SyntheticsAPIStep object is equal to o.
SyntheticsAPIStep	extractedValues(List<SyntheticsParsingOptions> extractedValues)
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.
List<SyntheticsParsingOptions>	getExtractedValues() Array of values to parse and save as variables from the response.
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.
SyntheticsAPIStepSubtype	getSubtype() The subtype of the Synthetic multistep API test step, currently only supporting http .
int	hashCode()
SyntheticsAPIStep	isCritical(Boolean isCritical)
SyntheticsAPIStep	name(String name)
SyntheticsAPIStep	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
SyntheticsAPIStep	request(SyntheticsTestRequest request)
SyntheticsAPIStep	retry(SyntheticsTestOptionsRetry retry)
void	setAllowFailure(Boolean allowFailure)
void	setAssertions(List<SyntheticsAssertion> assertions)
void	setExtractedValues(List<SyntheticsParsingOptions> extractedValues)
void	setIsCritical(Boolean isCritical)
void	setName(String name)
void	setRequest(SyntheticsTestRequest request)
void	setRetry(SyntheticsTestOptionsRetry retry)
void	setSubtype(SyntheticsAPIStepSubtype subtype)
SyntheticsAPIStep	subtype(SyntheticsAPIStepSubtype subtype)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

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_EXTRACTED_VALUES

public static final String JSON_PROPERTY_EXTRACTED_VALUES

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 Detail

SyntheticsAPIStep

public SyntheticsAPIStep()

SyntheticsAPIStep

public SyntheticsAPIStep(List<SyntheticsAssertion> assertions,
                         String name,
                         SyntheticsTestRequest request,
                         SyntheticsAPIStepSubtype subtype)

Method Detail

allowFailure

public SyntheticsAPIStep 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 SyntheticsAPIStep assertions(List<SyntheticsAssertion> assertions)

addAssertionsItem

public SyntheticsAPIStep addAssertionsItem(SyntheticsAssertion assertionsItem)

getAssertions

public List<SyntheticsAssertion> getAssertions()

Array of assertions used for the test.

Returns:

assertions

setAssertions

public void setAssertions(List<SyntheticsAssertion> assertions)

extractedValues

public SyntheticsAPIStep extractedValues(List<SyntheticsParsingOptions> extractedValues)

addExtractedValuesItem

public SyntheticsAPIStep 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)

isCritical

public SyntheticsAPIStep 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 SyntheticsAPIStep name(String name)

getName

public String getName()

The name of the step.

Returns:

name

setName

public void setName(String name)

request

public SyntheticsAPIStep request(SyntheticsTestRequest request)

getRequest

public SyntheticsTestRequest getRequest()

Object describing the Synthetic test request.

Returns:

request

setRequest

public void setRequest(SyntheticsTestRequest request)

retry

public SyntheticsAPIStep 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 SyntheticsAPIStep subtype(SyntheticsAPIStepSubtype subtype)

getSubtype

public SyntheticsAPIStepSubtype getSubtype()

The subtype of the Synthetic multistep API test step, currently only supporting http .

Returns:

subtype

setSubtype

public void setSubtype(SyntheticsAPIStepSubtype subtype)

putAdditionalProperty

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

SyntheticsAPIStep

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