com.datadog.api.client.v1.model

Class SyntheticsMobileStep

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsMobileStep

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

The steps used in a Synthetic mobile test.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ALLOW_FAILURE
static String	JSON_PROPERTY_HAS_NEW_STEP_ELEMENT
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_PUBLIC_ID
static String	JSON_PROPERTY_TIMEOUT
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SyntheticsMobileStep()
SyntheticsMobileStep(String name, SyntheticsMobileStepParams params, SyntheticsMobileStepType type)

Method Summary

Modifier and Type	Method and Description
SyntheticsMobileStep	allowFailure(Boolean allowFailure)
boolean	equals(Object o) Return true if this SyntheticsMobileStep 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	getHasNewStepElement() A boolean set to determine if the step has a new step element.
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.
SyntheticsMobileStepParams	getParams() The parameters of a mobile step.
String	getPublicId() The public ID of the step.
Long	getTimeout() The time before declaring a step failed.
SyntheticsMobileStepType	getType() Step type used in your mobile Synthetic test.
int	hashCode()
SyntheticsMobileStep	hasNewStepElement(Boolean hasNewStepElement)
SyntheticsMobileStep	isCritical(Boolean isCritical)
SyntheticsMobileStep	name(String name)
SyntheticsMobileStep	noScreenshot(Boolean noScreenshot)
SyntheticsMobileStep	params(SyntheticsMobileStepParams params)
SyntheticsMobileStep	publicId(String publicId)
SyntheticsMobileStep	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setAllowFailure(Boolean allowFailure)
void	setHasNewStepElement(Boolean hasNewStepElement)
void	setIsCritical(Boolean isCritical)
void	setName(String name)
void	setNoScreenshot(Boolean noScreenshot)
void	setParams(SyntheticsMobileStepParams params)
void	setPublicId(String publicId)
void	setTimeout(Long timeout)
void	setType(SyntheticsMobileStepType type)
SyntheticsMobileStep	timeout(Long timeout)
String	toString()
SyntheticsMobileStep	type(SyntheticsMobileStepType 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_HAS_NEW_STEP_ELEMENT

public static final String JSON_PROPERTY_HAS_NEW_STEP_ELEMENT

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_PUBLIC_ID

public static final String JSON_PROPERTY_PUBLIC_ID

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

SyntheticsMobileStep

public SyntheticsMobileStep()

SyntheticsMobileStep

public SyntheticsMobileStep(String name,
                            SyntheticsMobileStepParams params,
                            SyntheticsMobileStepType type)

Method Detail

allowFailure

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

hasNewStepElement

public SyntheticsMobileStep hasNewStepElement(Boolean hasNewStepElement)

getHasNewStepElement

@Nullable
public Boolean getHasNewStepElement()

A boolean set to determine if the step has a new step element.

Returns:

hasNewStepElement

setHasNewStepElement

public void setHasNewStepElement(Boolean hasNewStepElement)

isCritical

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

getName

public String getName()

The name of the step.

Returns:

name

setName

public void setName(String name)

noScreenshot

public SyntheticsMobileStep 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 SyntheticsMobileStep params(SyntheticsMobileStepParams params)

getParams

public SyntheticsMobileStepParams getParams()

The parameters of a mobile step.

Returns:

params

setParams

public void setParams(SyntheticsMobileStepParams params)

publicId

public SyntheticsMobileStep publicId(String publicId)

getPublicId

@Nullable
public String getPublicId()

The public ID of the step.

Returns:

publicId

setPublicId

public void setPublicId(String publicId)

timeout

public SyntheticsMobileStep 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 SyntheticsMobileStep type(SyntheticsMobileStepType type)

getType

public SyntheticsMobileStepType getType()

Step type used in your mobile Synthetic test.

Returns:

type

setType

public void setType(SyntheticsMobileStepType type)

putAdditionalProperty

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

SyntheticsMobileStep

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