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

Class SyntheticsMobileStepParams

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsMobileStepParams

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

The parameters of a mobile step.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CHECK
static final String	JSON_PROPERTY_DELAY
static final String	JSON_PROPERTY_DIRECTION
static final String	JSON_PROPERTY_ELEMENT
static final String	JSON_PROPERTY_ENABLED
static final String	JSON_PROPERTY_MAX_SCROLLS
static final String	JSON_PROPERTY_POSITIONS
static final String	JSON_PROPERTY_SUBTEST_PUBLIC_ID
static final String	JSON_PROPERTY_VALUE
static final String	JSON_PROPERTY_VARIABLE
static final String	JSON_PROPERTY_WITH_ENTER
static final String	JSON_PROPERTY_X
static final String	JSON_PROPERTY_Y
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
SyntheticsMobileStepParams()

Method Summary

Modifier and Type	Method	Description
SyntheticsMobileStepParams	addPositionsItem(SyntheticsMobileStepParamsPositionsItems positionsItem)
SyntheticsMobileStepParams	check(SyntheticsCheckType check)
SyntheticsMobileStepParams	delay(Long delay)
SyntheticsMobileStepParams	direction(SyntheticsMobileStepParamsDirection direction)
SyntheticsMobileStepParams	element(SyntheticsMobileStepParamsElement element)
SyntheticsMobileStepParams	enabled(Boolean enabled)
boolean	equals(Object o)	Return true if this SyntheticsMobileStepParams 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.
SyntheticsCheckType	getCheck()	Type of assertion to apply in an API test.
Long	getDelay()	Number of milliseconds to wait between inputs in a typeText step type.
SyntheticsMobileStepParamsDirection	getDirection()	The direction of the scroll for a scrollToElement step type.
SyntheticsMobileStepParamsElement	getElement()	Information about the element used for a step.
Boolean	getEnabled()	Boolean to change the state of the wifi for a toggleWiFi step type.
Long	getMaxScrolls()	Maximum number of scrolls to do for a scrollToElement step type.
List<SyntheticsMobileStepParamsPositionsItems>	getPositions()	List of positions for the flick step type.
String	getSubtestPublicId()	Public ID of the test to be played as part of a playSubTest step type.
SyntheticsMobileStepParamsValue	getValue()	Values used in the step for in multiple step types.
SyntheticsMobileStepParamsVariable	getVariable()	Variable object for extractVariable step type.
Boolean	getWithEnter()	Boolean to indicate if Enter should be pressed at the end of the typeText step type.
Double	getX()	Amount to scroll by on the x axis for a scroll step type.
Double	getY()	Amount to scroll by on the y axis for a scroll step type.
int	hashCode()
SyntheticsMobileStepParams	maxScrolls(Long maxScrolls)
SyntheticsMobileStepParams	positions(List<SyntheticsMobileStepParamsPositionsItems> positions)
SyntheticsMobileStepParams	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setCheck(SyntheticsCheckType check)
void	setDelay(Long delay)
void	setDirection(SyntheticsMobileStepParamsDirection direction)
void	setElement(SyntheticsMobileStepParamsElement element)
void	setEnabled(Boolean enabled)
void	setMaxScrolls(Long maxScrolls)
void	setPositions(List<SyntheticsMobileStepParamsPositionsItems> positions)
void	setSubtestPublicId(String subtestPublicId)
void	setValue(SyntheticsMobileStepParamsValue value)
void	setVariable(SyntheticsMobileStepParamsVariable variable)
void	setWithEnter(Boolean withEnter)
void	setX(Double x)
void	setY(Double y)
SyntheticsMobileStepParams	subtestPublicId(String subtestPublicId)
String	toString()
SyntheticsMobileStepParams	value(SyntheticsMobileStepParamsValue value)
SyntheticsMobileStepParams	variable(SyntheticsMobileStepParamsVariable variable)
SyntheticsMobileStepParams	withEnter(Boolean withEnter)
SyntheticsMobileStepParams	x(Double x)
SyntheticsMobileStepParams	y(Double y)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_CHECK

public static final String JSON_PROPERTY_CHECK

See Also:

• Constant Field Values

JSON_PROPERTY_DELAY

public static final String JSON_PROPERTY_DELAY

See Also:

• Constant Field Values

JSON_PROPERTY_DIRECTION

public static final String JSON_PROPERTY_DIRECTION

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT

public static final String JSON_PROPERTY_ELEMENT

See Also:

• Constant Field Values

JSON_PROPERTY_ENABLED

public static final String JSON_PROPERTY_ENABLED

See Also:

• Constant Field Values

JSON_PROPERTY_MAX_SCROLLS

public static final String JSON_PROPERTY_MAX_SCROLLS

See Also:

• Constant Field Values

JSON_PROPERTY_POSITIONS

public static final String JSON_PROPERTY_POSITIONS

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_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

• Constant Field Values

JSON_PROPERTY_VARIABLE

public static final String JSON_PROPERTY_VARIABLE

See Also:

• Constant Field Values

JSON_PROPERTY_WITH_ENTER

public static final String JSON_PROPERTY_WITH_ENTER

See Also:

• Constant Field Values

JSON_PROPERTY_X

public static final String JSON_PROPERTY_X

See Also:

• Constant Field Values

JSON_PROPERTY_Y

public static final String JSON_PROPERTY_Y

See Also:

• Constant Field Values

Constructor Details

SyntheticsMobileStepParams

public SyntheticsMobileStepParams()

Method Details

check

public SyntheticsMobileStepParams check(SyntheticsCheckType check)

getCheck

@Nullable
public SyntheticsCheckType getCheck()

Type of assertion to apply in an API test.

Returns:

check

setCheck

public void setCheck(SyntheticsCheckType check)

delay

public SyntheticsMobileStepParams delay(Long delay)

getDelay

@Nullable
public Long getDelay()

Number of milliseconds to wait between inputs in a typeText step type. minimum: 0 maximum: 5000

Returns:

delay

setDelay

public void setDelay(Long delay)

direction

public SyntheticsMobileStepParams direction(SyntheticsMobileStepParamsDirection direction)

getDirection

@Nullable
public SyntheticsMobileStepParamsDirection getDirection()

The direction of the scroll for a scrollToElement step type.

Returns:

direction

setDirection

public void setDirection(SyntheticsMobileStepParamsDirection direction)

element

public SyntheticsMobileStepParams element(SyntheticsMobileStepParamsElement element)

getElement

@Nullable
public SyntheticsMobileStepParamsElement getElement()

Information about the element used for a step.

Returns:

element

setElement

public void setElement(SyntheticsMobileStepParamsElement element)

enabled

public SyntheticsMobileStepParams enabled(Boolean enabled)

getEnabled

@Nullable
public Boolean getEnabled()

Boolean to change the state of the wifi for a toggleWiFi step type.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

maxScrolls

public SyntheticsMobileStepParams maxScrolls(Long maxScrolls)

getMaxScrolls

@Nullable
public Long getMaxScrolls()

Maximum number of scrolls to do for a scrollToElement step type.

Returns:

maxScrolls

setMaxScrolls

public void setMaxScrolls(Long maxScrolls)

positions

public SyntheticsMobileStepParams positions(List<SyntheticsMobileStepParamsPositionsItems> positions)

addPositionsItem

public SyntheticsMobileStepParams addPositionsItem(SyntheticsMobileStepParamsPositionsItems positionsItem)

getPositions

@Nullable
public List<SyntheticsMobileStepParamsPositionsItems> getPositions()

List of positions for the flick step type. The maximum is 10 flicks per step

Returns:

positions

setPositions

public void setPositions(List<SyntheticsMobileStepParamsPositionsItems> positions)

subtestPublicId

public SyntheticsMobileStepParams subtestPublicId(String subtestPublicId)

getSubtestPublicId

@Nullable
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)

value

public SyntheticsMobileStepParams value(SyntheticsMobileStepParamsValue value)

getValue

@Nullable
public SyntheticsMobileStepParamsValue getValue()

Values used in the step for in multiple step types.

Returns:

value

setValue

public void setValue(SyntheticsMobileStepParamsValue value)

variable

public SyntheticsMobileStepParams variable(SyntheticsMobileStepParamsVariable variable)

getVariable

@Nullable
public SyntheticsMobileStepParamsVariable getVariable()

Variable object for extractVariable step type.

Returns:

variable

setVariable

public void setVariable(SyntheticsMobileStepParamsVariable variable)

withEnter

public SyntheticsMobileStepParams withEnter(Boolean withEnter)

getWithEnter

@Nullable
public Boolean getWithEnter()

Boolean to indicate if Enter should be pressed at the end of the typeText step type.

Returns:

withEnter

setWithEnter

public void setWithEnter(Boolean withEnter)

x

public SyntheticsMobileStepParams x(Double x)

getX

@Nullable
public Double getX()

Amount to scroll by on the x axis for a scroll step type.

Returns:

x

setX

public void setX(Double x)

y

public SyntheticsMobileStepParams y(Double y)

getY

@Nullable
public Double getY()

Amount to scroll by on the y axis for a scroll step type.

Returns:

y

setY

public void setY(Double y)

putAdditionalProperty

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

SyntheticsMobileStepParams

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