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

Class SyntheticsStepDetail

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsStepDetail

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

Object describing a step for a Synthetic test.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ALLOW_FAILURE
static final String	JSON_PROPERTY_BROWSER_ERRORS
static final String	JSON_PROPERTY_CHECK_TYPE
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_DURATION
static final String	JSON_PROPERTY_ERROR
static final String	JSON_PROPERTY_FAILURE
static final String	JSON_PROPERTY_PLAYING_TAB
static final String	JSON_PROPERTY_SCREENSHOT_BUCKET_KEY
static final String	JSON_PROPERTY_SKIPPED
static final String	JSON_PROPERTY_SNAPSHOT_BUCKET_KEY
static final String	JSON_PROPERTY_STEP_ID
static final String	JSON_PROPERTY_SUB_TEST_STEP_DETAILS
static final String	JSON_PROPERTY_TIME_TO_INTERACTIVE
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_URL
static final String	JSON_PROPERTY_VALUE
static final String	JSON_PROPERTY_VITALS_METRICS
static final String	JSON_PROPERTY_WARNINGS
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
SyntheticsStepDetail()

Method Summary

Modifier and Type	Method	Description
SyntheticsStepDetail	addBrowserErrorsItem(SyntheticsBrowserError browserErrorsItem)
SyntheticsStepDetail	addSubTestStepDetailsItem(SyntheticsStepDetail subTestStepDetailsItem)
SyntheticsStepDetail	addVitalsMetricsItem(SyntheticsCoreWebVitals vitalsMetricsItem)
SyntheticsStepDetail	addWarningsItem(SyntheticsStepDetailWarning warningsItem)
SyntheticsStepDetail	allowFailure(Boolean allowFailure)
SyntheticsStepDetail	browserErrors(List<SyntheticsBrowserError> browserErrors)
SyntheticsStepDetail	checkType(SyntheticsCheckType checkType)
SyntheticsStepDetail	description(String description)
SyntheticsStepDetail	duration(Double duration)
boolean	equals(Object o)	Return true if this SyntheticsStepDetail object is equal to o.
SyntheticsStepDetail	error(String error)
SyntheticsStepDetail	failure(SyntheticsBrowserTestResultFailure failure)
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
Boolean	getAllowFailure()	Whether or not the step was allowed to fail.
List<SyntheticsBrowserError>	getBrowserErrors()	Array of errors collected for a browser test.
SyntheticsCheckType	getCheckType()	Type of assertion to apply in an API test.
String	getDescription()	Description of the test.
Double	getDuration()	Total duration in millisecond of the test.
String	getError()	Error returned by the test.
SyntheticsBrowserTestResultFailure	getFailure()	The browser test failure details.
SyntheticsPlayingTab	getPlayingTab()	Navigate between different tabs for your browser test.
Boolean	getScreenshotBucketKey()	Whether or not screenshots where collected by the test.
Boolean	getSkipped()	Whether or not to skip this step.
Boolean	getSnapshotBucketKey()	Whether or not snapshots where collected by the test.
Long	getStepId()	The step ID.
List<SyntheticsStepDetail>	getSubTestStepDetails()	If this step includes a sub-test.
Double	getTimeToInteractive()	Time before starting the step.
SyntheticsStepType	getType()	Step type used in your Synthetic test.
String	getUrl()	URL to perform the step against.
Object	getValue()	Value for the step.
List<SyntheticsCoreWebVitals>	getVitalsMetrics()	Array of Core Web Vitals metrics for the step.
List<SyntheticsStepDetailWarning>	getWarnings()	Warning collected that didn't failed the step.
int	hashCode()
SyntheticsStepDetail	playingTab(SyntheticsPlayingTab playingTab)
SyntheticsStepDetail	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
SyntheticsStepDetail	screenshotBucketKey(Boolean screenshotBucketKey)
void	setAllowFailure(Boolean allowFailure)
void	setBrowserErrors(List<SyntheticsBrowserError> browserErrors)
void	setCheckType(SyntheticsCheckType checkType)
void	setDescription(String description)
void	setDuration(Double duration)
void	setError(String error)
void	setFailure(SyntheticsBrowserTestResultFailure failure)
void	setPlayingTab(SyntheticsPlayingTab playingTab)
void	setScreenshotBucketKey(Boolean screenshotBucketKey)
void	setSkipped(Boolean skipped)
void	setSnapshotBucketKey(Boolean snapshotBucketKey)
void	setStepId(Long stepId)
void	setSubTestStepDetails(List<SyntheticsStepDetail> subTestStepDetails)
void	setTimeToInteractive(Double timeToInteractive)
void	setType(SyntheticsStepType type)
void	setUrl(String url)
void	setValue(Object value)
void	setVitalsMetrics(List<SyntheticsCoreWebVitals> vitalsMetrics)
void	setWarnings(List<SyntheticsStepDetailWarning> warnings)
SyntheticsStepDetail	skipped(Boolean skipped)
SyntheticsStepDetail	snapshotBucketKey(Boolean snapshotBucketKey)
SyntheticsStepDetail	stepId(Long stepId)
SyntheticsStepDetail	subTestStepDetails(List<SyntheticsStepDetail> subTestStepDetails)
SyntheticsStepDetail	timeToInteractive(Double timeToInteractive)
String	toString()
SyntheticsStepDetail	type(SyntheticsStepType type)
SyntheticsStepDetail	url(String url)
SyntheticsStepDetail	value(Object value)
SyntheticsStepDetail	vitalsMetrics(List<SyntheticsCoreWebVitals> vitalsMetrics)
SyntheticsStepDetail	warnings(List<SyntheticsStepDetailWarning> warnings)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_ALLOW_FAILURE

public static final String JSON_PROPERTY_ALLOW_FAILURE

See Also:

• Constant Field Values

JSON_PROPERTY_BROWSER_ERRORS

public static final String JSON_PROPERTY_BROWSER_ERRORS

See Also:

• Constant Field Values

JSON_PROPERTY_CHECK_TYPE

public static final String JSON_PROPERTY_CHECK_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_DURATION

public static final String JSON_PROPERTY_DURATION

See Also:

• Constant Field Values

JSON_PROPERTY_ERROR

public static final String JSON_PROPERTY_ERROR

See Also:

• Constant Field Values

JSON_PROPERTY_FAILURE

public static final String JSON_PROPERTY_FAILURE

See Also:

• Constant Field Values

JSON_PROPERTY_PLAYING_TAB

public static final String JSON_PROPERTY_PLAYING_TAB

See Also:

• Constant Field Values

JSON_PROPERTY_SCREENSHOT_BUCKET_KEY

public static final String JSON_PROPERTY_SCREENSHOT_BUCKET_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_SKIPPED

public static final String JSON_PROPERTY_SKIPPED

See Also:

• Constant Field Values

JSON_PROPERTY_SNAPSHOT_BUCKET_KEY

public static final String JSON_PROPERTY_SNAPSHOT_BUCKET_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_STEP_ID

public static final String JSON_PROPERTY_STEP_ID

See Also:

• Constant Field Values

JSON_PROPERTY_SUB_TEST_STEP_DETAILS

public static final String JSON_PROPERTY_SUB_TEST_STEP_DETAILS

See Also:

• Constant Field Values

JSON_PROPERTY_TIME_TO_INTERACTIVE

public static final String JSON_PROPERTY_TIME_TO_INTERACTIVE

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_URL

public static final String JSON_PROPERTY_URL

See Also:

• Constant Field Values

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

• Constant Field Values

JSON_PROPERTY_VITALS_METRICS

public static final String JSON_PROPERTY_VITALS_METRICS

See Also:

• Constant Field Values

JSON_PROPERTY_WARNINGS

public static final String JSON_PROPERTY_WARNINGS

See Also:

• Constant Field Values

Constructor Details

SyntheticsStepDetail

public SyntheticsStepDetail()

Method Details

allowFailure

public SyntheticsStepDetail allowFailure(Boolean allowFailure)

getAllowFailure

@Nullable
public Boolean getAllowFailure()

Whether or not the step was allowed to fail.

Returns:

allowFailure

setAllowFailure

public void setAllowFailure(Boolean allowFailure)

browserErrors

public SyntheticsStepDetail browserErrors(List<SyntheticsBrowserError> browserErrors)

addBrowserErrorsItem

public SyntheticsStepDetail addBrowserErrorsItem(SyntheticsBrowserError browserErrorsItem)

getBrowserErrors

@Nullable
public List<SyntheticsBrowserError> getBrowserErrors()

Array of errors collected for a browser test.

Returns:

browserErrors

setBrowserErrors

public void setBrowserErrors(List<SyntheticsBrowserError> browserErrors)

checkType

public SyntheticsStepDetail checkType(SyntheticsCheckType checkType)

getCheckType

@Nullable
public SyntheticsCheckType getCheckType()

Type of assertion to apply in an API test.

Returns:

checkType

setCheckType

public void setCheckType(SyntheticsCheckType checkType)

description

public SyntheticsStepDetail description(String description)

getDescription

@Nullable
public String getDescription()

Description of the test.

Returns:

description

setDescription

public void setDescription(String description)

duration

public SyntheticsStepDetail duration(Double duration)

getDuration

@Nullable
public Double getDuration()

Total duration in millisecond of the test.

Returns:

duration

setDuration

public void setDuration(Double duration)

error

public SyntheticsStepDetail error(String error)

getError

@Nullable
public String getError()

Error returned by the test.

Returns:

error

setError

public void setError(String error)

failure

public SyntheticsStepDetail failure(SyntheticsBrowserTestResultFailure failure)

getFailure

@Nullable
public SyntheticsBrowserTestResultFailure getFailure()

The browser test failure details.

Returns:

failure

setFailure

public void setFailure(SyntheticsBrowserTestResultFailure failure)

playingTab

public SyntheticsStepDetail playingTab(SyntheticsPlayingTab playingTab)

getPlayingTab

@Nullable
public SyntheticsPlayingTab getPlayingTab()

Navigate between different tabs for your browser test.

Returns:

playingTab

setPlayingTab

public void setPlayingTab(SyntheticsPlayingTab playingTab)

screenshotBucketKey

public SyntheticsStepDetail screenshotBucketKey(Boolean screenshotBucketKey)

getScreenshotBucketKey

@Nullable
public Boolean getScreenshotBucketKey()

Whether or not screenshots where collected by the test.

Returns:

screenshotBucketKey

setScreenshotBucketKey

public void setScreenshotBucketKey(Boolean screenshotBucketKey)

skipped

public SyntheticsStepDetail skipped(Boolean skipped)

getSkipped

@Nullable
public Boolean getSkipped()

Whether or not to skip this step.

Returns:

skipped

setSkipped

public void setSkipped(Boolean skipped)

snapshotBucketKey

public SyntheticsStepDetail snapshotBucketKey(Boolean snapshotBucketKey)

getSnapshotBucketKey

@Nullable
public Boolean getSnapshotBucketKey()

Whether or not snapshots where collected by the test.

Returns:

snapshotBucketKey

setSnapshotBucketKey

public void setSnapshotBucketKey(Boolean snapshotBucketKey)

stepId

public SyntheticsStepDetail stepId(Long stepId)

getStepId

@Nullable
public Long getStepId()

The step ID.

Returns:

stepId

setStepId

public void setStepId(Long stepId)

subTestStepDetails

public SyntheticsStepDetail subTestStepDetails(List<SyntheticsStepDetail> subTestStepDetails)

addSubTestStepDetailsItem

public SyntheticsStepDetail addSubTestStepDetailsItem(SyntheticsStepDetail subTestStepDetailsItem)

getSubTestStepDetails

@Nullable
public List<SyntheticsStepDetail> getSubTestStepDetails()

If this step includes a sub-test. Subtests documentation.

Returns:

subTestStepDetails

setSubTestStepDetails

public void setSubTestStepDetails(List<SyntheticsStepDetail> subTestStepDetails)

timeToInteractive

public SyntheticsStepDetail timeToInteractive(Double timeToInteractive)

getTimeToInteractive

@Nullable
public Double getTimeToInteractive()

Time before starting the step.

Returns:

timeToInteractive

setTimeToInteractive

public void setTimeToInteractive(Double timeToInteractive)

type

public SyntheticsStepDetail type(SyntheticsStepType type)

getType

@Nullable
public SyntheticsStepType getType()

Step type used in your Synthetic test.

Returns:

type

setType

public void setType(SyntheticsStepType type)

url

public SyntheticsStepDetail url(String url)

getUrl

@Nullable
public String getUrl()

URL to perform the step against.

Returns:

url

setUrl

public void setUrl(String url)

value

public SyntheticsStepDetail value(Object value)

getValue

@Nullable
public Object getValue()

Value for the step.

Returns:

value

setValue

public void setValue(Object value)

vitalsMetrics

public SyntheticsStepDetail vitalsMetrics(List<SyntheticsCoreWebVitals> vitalsMetrics)

addVitalsMetricsItem

public SyntheticsStepDetail addVitalsMetricsItem(SyntheticsCoreWebVitals vitalsMetricsItem)

getVitalsMetrics

@Nullable
public List<SyntheticsCoreWebVitals> getVitalsMetrics()

Array of Core Web Vitals metrics for the step.

Returns:

vitalsMetrics

setVitalsMetrics

public void setVitalsMetrics(List<SyntheticsCoreWebVitals> vitalsMetrics)

warnings

public SyntheticsStepDetail warnings(List<SyntheticsStepDetailWarning> warnings)

addWarningsItem

public SyntheticsStepDetail addWarningsItem(SyntheticsStepDetailWarning warningsItem)

getWarnings

@Nullable
public List<SyntheticsStepDetailWarning> getWarnings()

Warning collected that didn't failed the step.

Returns:

warnings

setWarnings

public void setWarnings(List<SyntheticsStepDetailWarning> warnings)

putAdditionalProperty

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

SyntheticsStepDetail

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