com.datadog.api.client.v1.model

Class SyntheticsStep

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsStep

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

The steps used in a Synthetic browser test.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ALLOW_FAILURE
static String	JSON_PROPERTY_IS_CRITICAL
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_NO_SCREENSHOT
static String	JSON_PROPERTY_PARAMS
static String	JSON_PROPERTY_TIMEOUT
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SyntheticsStep()

Method Summary

Modifier and Type	Method and Description
SyntheticsStep	allowFailure(Boolean allowFailure)
boolean	equals(Object o) Return true if this SyntheticsStep 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.
Boolean	getAllowFailure() A boolean set to allow this step to fail.
Boolean	getIsCritical() A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
String	getName() The name of the step.
Boolean	getNoScreenshot() A boolean set to not take a screenshot for the step.
Object	getParams() The parameters of the step.
Long	getTimeout() The time before declaring a step failed.
SyntheticsStepType	getType() Step type used in your Synthetic test.
int	hashCode()
SyntheticsStep	isCritical(Boolean isCritical)
SyntheticsStep	name(String name)
SyntheticsStep	noScreenshot(Boolean noScreenshot)
SyntheticsStep	params(Object params)
SyntheticsStep	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setAllowFailure(Boolean allowFailure)
void	setIsCritical(Boolean isCritical)
void	setName(String name)
void	setNoScreenshot(Boolean noScreenshot)
void	setParams(Object params)
void	setTimeout(Long timeout)
void	setType(SyntheticsStepType type)
SyntheticsStep	timeout(Long timeout)
String	toString()
SyntheticsStep	type(SyntheticsStepType type)

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

public static final String JSON_PROPERTY_NO_SCREENSHOT

See Also:

Constant Field Values

JSON_PROPERTY_PARAMS

public static final String JSON_PROPERTY_PARAMS

See Also:

Constant Field Values

JSON_PROPERTY_TIMEOUT

public static final String JSON_PROPERTY_TIMEOUT

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

SyntheticsStep

public SyntheticsStep()

Method Detail

allowFailure

public SyntheticsStep allowFailure(Boolean allowFailure)

getAllowFailure

@Nullable
public Boolean getAllowFailure()

A boolean set to allow this step to fail.

Returns:

allowFailure

setAllowFailure

public void setAllowFailure(Boolean allowFailure)

isCritical

public SyntheticsStep isCritical(Boolean isCritical)

getIsCritical

@Nullable
public Boolean getIsCritical()

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

Returns:

isCritical

setIsCritical

public void setIsCritical(Boolean isCritical)

name

public SyntheticsStep name(String name)

getName

@Nullable
public String getName()

The name of the step.

Returns:

name

setName

public void setName(String name)

noScreenshot

public SyntheticsStep noScreenshot(Boolean noScreenshot)

getNoScreenshot

@Nullable
public Boolean getNoScreenshot()

A boolean set to not take a screenshot for the step.

Returns:

noScreenshot

setNoScreenshot

public void setNoScreenshot(Boolean noScreenshot)

params

public SyntheticsStep params(Object params)

getParams

@Nullable
public Object getParams()

The parameters of the step.

Returns:

params

setParams

public void setParams(Object params)

timeout

public SyntheticsStep timeout(Long timeout)

getTimeout

@Nullable
public Long getTimeout()

The time before declaring a step failed.

Returns:

timeout

setTimeout

public void setTimeout(Long timeout)

type

public SyntheticsStep type(SyntheticsStepType type)

getType

@Nullable
public SyntheticsStepType getType()

Step type used in your Synthetic test.

Returns:

type

setType

public void setType(SyntheticsStepType type)

putAdditionalProperty

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

SyntheticsStep

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