com.datadog.api.client.v1.model

Class SyntheticsMobileTestOptions

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsMobileTestOptions

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

Object describing the extra options for a Synthetic test.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ALLOW_APPLICATION_CRASH
static String	JSON_PROPERTY_BINDINGS
static String	JSON_PROPERTY_CI
static String	JSON_PROPERTY_DEFAULT_STEP_TIMEOUT
static String	JSON_PROPERTY_DEVICE_IDS
static String	JSON_PROPERTY_DISABLE_AUTO_ACCEPT_ALERT
static String	JSON_PROPERTY_MIN_FAILURE_DURATION
static String	JSON_PROPERTY_MOBILE_APPLICATION
static String	JSON_PROPERTY_MONITOR_NAME
static String	JSON_PROPERTY_MONITOR_OPTIONS
static String	JSON_PROPERTY_MONITOR_PRIORITY
static String	JSON_PROPERTY_NO_SCREENSHOT
static String	JSON_PROPERTY_RESTRICTED_ROLES
static String	JSON_PROPERTY_RETRY
static String	JSON_PROPERTY_SCHEDULING
static String	JSON_PROPERTY_TICK_EVERY
static String	JSON_PROPERTY_VERBOSITY
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SyntheticsMobileTestOptions()
SyntheticsMobileTestOptions(List<String> deviceIds, SyntheticsMobileTestsMobileApplication mobileApplication, Long tickEvery)

Method Summary

Modifier and Type	Method and Description
SyntheticsMobileTestOptions	addBindingsItem(SyntheticsTestRestrictionPolicyBinding bindingsItem)
SyntheticsMobileTestOptions	addDeviceIdsItem(String deviceIdsItem)
SyntheticsMobileTestOptions	addRestrictedRolesItem(String restrictedRolesItem)
SyntheticsMobileTestOptions	allowApplicationCrash(Boolean allowApplicationCrash)
SyntheticsMobileTestOptions	bindings(List<SyntheticsTestRestrictionPolicyBinding> bindings)
SyntheticsMobileTestOptions	ci(SyntheticsTestCiOptions ci)
SyntheticsMobileTestOptions	defaultStepTimeout(Integer defaultStepTimeout)
SyntheticsMobileTestOptions	deviceIds(List<String> deviceIds)
SyntheticsMobileTestOptions	disableAutoAcceptAlert(Boolean disableAutoAcceptAlert)
boolean	equals(Object o) Return true if this SyntheticsMobileTestOptions 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	getAllowApplicationCrash() A boolean to set if an application crash would mark the test as failed.
List<SyntheticsTestRestrictionPolicyBinding>	getBindings() Array of bindings used for the mobile test.
SyntheticsTestCiOptions	getCi() CI/CD options for a Synthetic test.
Integer	getDefaultStepTimeout() The default timeout for steps in the test (in seconds).
List<String>	getDeviceIds() For mobile test, array with the different device IDs used to run the test.
Boolean	getDisableAutoAcceptAlert() A boolean to disable auto accepting alerts.
Long	getMinFailureDuration() Minimum amount of time in failure required to trigger an alert.
SyntheticsMobileTestsMobileApplication	getMobileApplication() Mobile application for mobile synthetics test.
String	getMonitorName() The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
SyntheticsTestOptionsMonitorOptions	getMonitorOptions() Object containing the options for a Synthetic test as a monitor (for example, renotification).
Integer	getMonitorPriority() Integer from 1 (high) to 5 (low) indicating alert severity.
Boolean	getNoScreenshot() A boolean set to not take a screenshot for the step.
List<String>	getRestrictedRoles() Deprecated.
SyntheticsTestOptionsRetry	getRetry() Object describing the retry strategy to apply to a Synthetic test.
SyntheticsTestOptionsScheduling	getScheduling() Object containing timeframes and timezone used for advanced scheduling.
Long	getTickEvery() The frequency at which to run the Synthetic test (in seconds).
Integer	getVerbosity() The level of verbosity for the mobile test.
int	hashCode()
SyntheticsMobileTestOptions	minFailureDuration(Long minFailureDuration)
SyntheticsMobileTestOptions	mobileApplication(SyntheticsMobileTestsMobileApplication mobileApplication)
SyntheticsMobileTestOptions	monitorName(String monitorName)
SyntheticsMobileTestOptions	monitorOptions(SyntheticsTestOptionsMonitorOptions monitorOptions)
SyntheticsMobileTestOptions	monitorPriority(Integer monitorPriority)
SyntheticsMobileTestOptions	noScreenshot(Boolean noScreenshot)
SyntheticsMobileTestOptions	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
SyntheticsMobileTestOptions	restrictedRoles(List<String> restrictedRoles)
SyntheticsMobileTestOptions	retry(SyntheticsTestOptionsRetry retry)
SyntheticsMobileTestOptions	scheduling(SyntheticsTestOptionsScheduling scheduling)
void	setAllowApplicationCrash(Boolean allowApplicationCrash)
void	setBindings(List<SyntheticsTestRestrictionPolicyBinding> bindings)
void	setCi(SyntheticsTestCiOptions ci)
void	setDefaultStepTimeout(Integer defaultStepTimeout)
void	setDeviceIds(List<String> deviceIds)
void	setDisableAutoAcceptAlert(Boolean disableAutoAcceptAlert)
void	setMinFailureDuration(Long minFailureDuration)
void	setMobileApplication(SyntheticsMobileTestsMobileApplication mobileApplication)
void	setMonitorName(String monitorName)
void	setMonitorOptions(SyntheticsTestOptionsMonitorOptions monitorOptions)
void	setMonitorPriority(Integer monitorPriority)
void	setNoScreenshot(Boolean noScreenshot)
void	setRestrictedRoles(List<String> restrictedRoles) Deprecated.
void	setRetry(SyntheticsTestOptionsRetry retry)
void	setScheduling(SyntheticsTestOptionsScheduling scheduling)
void	setTickEvery(Long tickEvery)
void	setVerbosity(Integer verbosity)
SyntheticsMobileTestOptions	tickEvery(Long tickEvery)
String	toString()
SyntheticsMobileTestOptions	verbosity(Integer verbosity)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_ALLOW_APPLICATION_CRASH

public static final String JSON_PROPERTY_ALLOW_APPLICATION_CRASH

See Also:

Constant Field Values

JSON_PROPERTY_BINDINGS

public static final String JSON_PROPERTY_BINDINGS

See Also:

Constant Field Values

JSON_PROPERTY_CI

public static final String JSON_PROPERTY_CI

See Also:

Constant Field Values

JSON_PROPERTY_DEFAULT_STEP_TIMEOUT

public static final String JSON_PROPERTY_DEFAULT_STEP_TIMEOUT

See Also:

Constant Field Values

JSON_PROPERTY_DEVICE_IDS

public static final String JSON_PROPERTY_DEVICE_IDS

See Also:

Constant Field Values

JSON_PROPERTY_DISABLE_AUTO_ACCEPT_ALERT

public static final String JSON_PROPERTY_DISABLE_AUTO_ACCEPT_ALERT

See Also:

Constant Field Values

JSON_PROPERTY_MIN_FAILURE_DURATION

public static final String JSON_PROPERTY_MIN_FAILURE_DURATION

See Also:

Constant Field Values

JSON_PROPERTY_MOBILE_APPLICATION

public static final String JSON_PROPERTY_MOBILE_APPLICATION

See Also:

Constant Field Values

JSON_PROPERTY_MONITOR_NAME

public static final String JSON_PROPERTY_MONITOR_NAME

See Also:

Constant Field Values

JSON_PROPERTY_MONITOR_OPTIONS

public static final String JSON_PROPERTY_MONITOR_OPTIONS

See Also:

Constant Field Values

JSON_PROPERTY_MONITOR_PRIORITY

public static final String JSON_PROPERTY_MONITOR_PRIORITY

See Also:

Constant Field Values

JSON_PROPERTY_NO_SCREENSHOT

public static final String JSON_PROPERTY_NO_SCREENSHOT

See Also:

Constant Field Values

JSON_PROPERTY_RESTRICTED_ROLES

public static final String JSON_PROPERTY_RESTRICTED_ROLES

See Also:

Constant Field Values

JSON_PROPERTY_RETRY

public static final String JSON_PROPERTY_RETRY

See Also:

Constant Field Values

JSON_PROPERTY_SCHEDULING

public static final String JSON_PROPERTY_SCHEDULING

See Also:

Constant Field Values

JSON_PROPERTY_TICK_EVERY

public static final String JSON_PROPERTY_TICK_EVERY

See Also:

Constant Field Values

JSON_PROPERTY_VERBOSITY

public static final String JSON_PROPERTY_VERBOSITY

See Also:

Constant Field Values

Constructor Detail

SyntheticsMobileTestOptions

public SyntheticsMobileTestOptions()

SyntheticsMobileTestOptions

public SyntheticsMobileTestOptions(List<String> deviceIds,
                                   SyntheticsMobileTestsMobileApplication mobileApplication,
                                   Long tickEvery)

Method Detail

allowApplicationCrash

public SyntheticsMobileTestOptions allowApplicationCrash(Boolean allowApplicationCrash)

getAllowApplicationCrash

@Nullable
public Boolean getAllowApplicationCrash()

A boolean to set if an application crash would mark the test as failed.

Returns:

allowApplicationCrash

setAllowApplicationCrash

public void setAllowApplicationCrash(Boolean allowApplicationCrash)

bindings

public SyntheticsMobileTestOptions bindings(List<SyntheticsTestRestrictionPolicyBinding> bindings)

addBindingsItem

public SyntheticsMobileTestOptions addBindingsItem(SyntheticsTestRestrictionPolicyBinding bindingsItem)

getBindings

@Nullable
public List<SyntheticsTestRestrictionPolicyBinding> getBindings()

Array of bindings used for the mobile test.

Returns:

bindings

setBindings

public void setBindings(List<SyntheticsTestRestrictionPolicyBinding> bindings)

ci

public SyntheticsMobileTestOptions ci(SyntheticsTestCiOptions ci)

getCi

@Nullable
public SyntheticsTestCiOptions getCi()

CI/CD options for a Synthetic test.

Returns:

ci

setCi

public void setCi(SyntheticsTestCiOptions ci)

defaultStepTimeout

public SyntheticsMobileTestOptions defaultStepTimeout(Integer defaultStepTimeout)

getDefaultStepTimeout

@Nullable
public Integer getDefaultStepTimeout()

The default timeout for steps in the test (in seconds). minimum: 1 maximum: 300

Returns:

defaultStepTimeout

setDefaultStepTimeout

public void setDefaultStepTimeout(Integer defaultStepTimeout)

deviceIds

public SyntheticsMobileTestOptions deviceIds(List<String> deviceIds)

addDeviceIdsItem

public SyntheticsMobileTestOptions addDeviceIdsItem(String deviceIdsItem)

getDeviceIds

public List<String> getDeviceIds()

For mobile test, array with the different device IDs used to run the test.

Returns:

deviceIds

setDeviceIds

public void setDeviceIds(List<String> deviceIds)

disableAutoAcceptAlert

public SyntheticsMobileTestOptions disableAutoAcceptAlert(Boolean disableAutoAcceptAlert)

getDisableAutoAcceptAlert

@Nullable
public Boolean getDisableAutoAcceptAlert()

A boolean to disable auto accepting alerts.

Returns:

disableAutoAcceptAlert

setDisableAutoAcceptAlert

public void setDisableAutoAcceptAlert(Boolean disableAutoAcceptAlert)

minFailureDuration

public SyntheticsMobileTestOptions minFailureDuration(Long minFailureDuration)

getMinFailureDuration

@Nullable
public Long getMinFailureDuration()

Minimum amount of time in failure required to trigger an alert. minimum: 0 maximum: 7200

Returns:

minFailureDuration

setMinFailureDuration

public void setMinFailureDuration(Long minFailureDuration)

mobileApplication

public SyntheticsMobileTestOptions mobileApplication(SyntheticsMobileTestsMobileApplication mobileApplication)

getMobileApplication

public SyntheticsMobileTestsMobileApplication getMobileApplication()

Mobile application for mobile synthetics test.

Returns:

mobileApplication

setMobileApplication

public void setMobileApplication(SyntheticsMobileTestsMobileApplication mobileApplication)

monitorName

public SyntheticsMobileTestOptions monitorName(String monitorName)

getMonitorName

@Nullable
public String getMonitorName()

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

Returns:

monitorName

setMonitorName

public void setMonitorName(String monitorName)

monitorOptions

public SyntheticsMobileTestOptions monitorOptions(SyntheticsTestOptionsMonitorOptions monitorOptions)

getMonitorOptions

@Nullable
public SyntheticsTestOptionsMonitorOptions getMonitorOptions()

Object containing the options for a Synthetic test as a monitor (for example, renotification).

Returns:

monitorOptions

setMonitorOptions

public void setMonitorOptions(SyntheticsTestOptionsMonitorOptions monitorOptions)

monitorPriority

public SyntheticsMobileTestOptions monitorPriority(Integer monitorPriority)

getMonitorPriority

@Nullable
public Integer getMonitorPriority()

Integer from 1 (high) to 5 (low) indicating alert severity. minimum: 1 maximum: 5

Returns:

monitorPriority

setMonitorPriority

public void setMonitorPriority(Integer monitorPriority)

noScreenshot

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

restrictedRoles

public SyntheticsMobileTestOptions restrictedRoles(List<String> restrictedRoles)

addRestrictedRolesItem

public SyntheticsMobileTestOptions addRestrictedRolesItem(String restrictedRolesItem)

getRestrictedRoles

@Deprecated
 @Nullable
public List<String> getRestrictedRoles()

Deprecated.

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions.

Returns:

restrictedRoles

setRestrictedRoles

@Deprecated
public void setRestrictedRoles(List<String> restrictedRoles)

Deprecated.

retry

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

scheduling

public SyntheticsMobileTestOptions scheduling(SyntheticsTestOptionsScheduling scheduling)

getScheduling

@Nullable
public SyntheticsTestOptionsScheduling getScheduling()

Object containing timeframes and timezone used for advanced scheduling.

Returns:

scheduling

setScheduling

public void setScheduling(SyntheticsTestOptionsScheduling scheduling)

tickEvery

public SyntheticsMobileTestOptions tickEvery(Long tickEvery)

getTickEvery

public Long getTickEvery()

The frequency at which to run the Synthetic test (in seconds). minimum: 300 maximum: 604800

Returns:

tickEvery

setTickEvery

public void setTickEvery(Long tickEvery)

verbosity

public SyntheticsMobileTestOptions verbosity(Integer verbosity)

getVerbosity

@Nullable
public Integer getVerbosity()

The level of verbosity for the mobile test. This field can not be set by a user. minimum: 0 maximum: 5

Returns:

verbosity

setVerbosity

public void setVerbosity(Integer verbosity)

putAdditionalProperty

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

SyntheticsMobileTestOptions

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