com.datadog.api.client.v1.model

Class SyntheticsAPISubtestStep

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsAPISubtestStep

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

The subtest step used in a Synthetics multi-step API test.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ALLOW_FAILURE
static String	JSON_PROPERTY_ALWAYS_EXECUTE
static String	JSON_PROPERTY_EXIT_IF_SUCCEED
static String	JSON_PROPERTY_EXTRACTED_VALUES_FROM_SCRIPT
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_IS_CRITICAL
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_RETRY
static String	JSON_PROPERTY_SUBTEST_PUBLIC_ID
static String	JSON_PROPERTY_SUBTYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SyntheticsAPISubtestStep()
SyntheticsAPISubtestStep(String name, String subtestPublicId, SyntheticsAPISubtestStepSubtype subtype)

Method Summary

Modifier and Type	Method and Description
SyntheticsAPISubtestStep	allowFailure(Boolean allowFailure)
SyntheticsAPISubtestStep	alwaysExecute(Boolean alwaysExecute)
boolean	equals(Object o) Return true if this SyntheticsAPISubtestStep object is equal to o.
SyntheticsAPISubtestStep	exitIfSucceed(Boolean exitIfSucceed)
SyntheticsAPISubtestStep	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.
Boolean	getAlwaysExecute() A boolean set to always execute this step even if the previous step failed or was skipped.
Boolean	getExitIfSucceed() Determines whether or not to exit the test if the step succeeds.
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.
SyntheticsTestOptionsRetry	getRetry() Object describing the retry strategy to apply to a Synthetic test.
String	getSubtestPublicId() Public ID of the test to be played as part of a playSubTest step type.
SyntheticsAPISubtestStepSubtype	getSubtype() The subtype of the Synthetic multi-step API subtest step.
int	hashCode()
SyntheticsAPISubtestStep	isCritical(Boolean isCritical)
SyntheticsAPISubtestStep	name(String name)
SyntheticsAPISubtestStep	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
SyntheticsAPISubtestStep	retry(SyntheticsTestOptionsRetry retry)
void	setAllowFailure(Boolean allowFailure)
void	setAlwaysExecute(Boolean alwaysExecute)
void	setExitIfSucceed(Boolean exitIfSucceed)
void	setExtractedValuesFromScript(String extractedValuesFromScript)
void	setIsCritical(Boolean isCritical)
void	setName(String name)
void	setRetry(SyntheticsTestOptionsRetry retry)
void	setSubtestPublicId(String subtestPublicId)
void	setSubtype(SyntheticsAPISubtestStepSubtype subtype)
SyntheticsAPISubtestStep	subtestPublicId(String subtestPublicId)
SyntheticsAPISubtestStep	subtype(SyntheticsAPISubtestStepSubtype 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_ALWAYS_EXECUTE

public static final String JSON_PROPERTY_ALWAYS_EXECUTE

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_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_RETRY

public static final String JSON_PROPERTY_RETRY

See Also:

Constant Field Values

JSON_PROPERTY_SUBTEST_PUBLIC_ID

public static final String JSON_PROPERTY_SUBTEST_PUBLIC_ID

See Also:

Constant Field Values

JSON_PROPERTY_SUBTYPE

public static final String JSON_PROPERTY_SUBTYPE

See Also:

Constant Field Values

Constructor Detail

SyntheticsAPISubtestStep

public SyntheticsAPISubtestStep()

SyntheticsAPISubtestStep

public SyntheticsAPISubtestStep(String name,
                                String subtestPublicId,
                                SyntheticsAPISubtestStepSubtype subtype)

Method Detail

allowFailure

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

alwaysExecute

public SyntheticsAPISubtestStep alwaysExecute(Boolean alwaysExecute)

getAlwaysExecute

@Nullable
public Boolean getAlwaysExecute()

A boolean set to always execute this step even if the previous step failed or was skipped.

Returns:

alwaysExecute

setAlwaysExecute

public void setAlwaysExecute(Boolean alwaysExecute)

exitIfSucceed

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

extractedValuesFromScript

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

getName

public String getName()

The name of the step.

Returns:

name

setName

public void setName(String name)

retry

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

subtestPublicId

public SyntheticsAPISubtestStep subtestPublicId(String subtestPublicId)

getSubtestPublicId

public String getSubtestPublicId()

Public ID of the test to be played as part of a playSubTest step type.

Returns:

subtestPublicId

setSubtestPublicId

public void setSubtestPublicId(String subtestPublicId)

subtype

public SyntheticsAPISubtestStep subtype(SyntheticsAPISubtestStepSubtype subtype)

getSubtype

public SyntheticsAPISubtestStepSubtype getSubtype()

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

Returns:

subtype

setSubtype

public void setSubtype(SyntheticsAPISubtestStepSubtype subtype)

putAdditionalProperty

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

SyntheticsAPISubtestStep

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