com.datadog.api.client.v1.model

Class SyntheticsTestOptions

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsTestOptions

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

Object describing the extra options for a Synthetic test.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ACCEPT_SELF_SIGNED
static String	JSON_PROPERTY_ALLOW_INSECURE
static String	JSON_PROPERTY_CHECK_CERTIFICATE_REVOCATION
static String	JSON_PROPERTY_CI
static String	JSON_PROPERTY_DEVICE_IDS
static String	JSON_PROPERTY_DISABLE_CORS
static String	JSON_PROPERTY_DISABLE_CSP
static String	JSON_PROPERTY_ENABLE_PROFILING
static String	JSON_PROPERTY_ENABLE_SECURITY_TESTING
static String	JSON_PROPERTY_FOLLOW_REDIRECTS
static String	JSON_PROPERTY_HTTP_VERSION
static String	JSON_PROPERTY_IGNORE_SERVER_CERTIFICATE_ERROR
static String	JSON_PROPERTY_INITIAL_NAVIGATION_TIMEOUT
static String	JSON_PROPERTY_MIN_FAILURE_DURATION
static String	JSON_PROPERTY_MIN_LOCATION_FAILED
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_RUM_SETTINGS
static String	JSON_PROPERTY_SCHEDULING
static String	JSON_PROPERTY_TICK_EVERY
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SyntheticsTestOptions()

Method Summary

Modifier and Type	Method and Description
SyntheticsTestOptions	acceptSelfSigned(Boolean acceptSelfSigned)
SyntheticsTestOptions	addDeviceIdsItem(SyntheticsDeviceID deviceIdsItem)
SyntheticsTestOptions	addRestrictedRolesItem(String restrictedRolesItem)
SyntheticsTestOptions	allowInsecure(Boolean allowInsecure)
SyntheticsTestOptions	checkCertificateRevocation(Boolean checkCertificateRevocation)
SyntheticsTestOptions	ci(SyntheticsTestCiOptions ci)
SyntheticsTestOptions	deviceIds(List<SyntheticsDeviceID> deviceIds)
SyntheticsTestOptions	disableCors(Boolean disableCors)
SyntheticsTestOptions	disableCsp(Boolean disableCsp)
SyntheticsTestOptions	enableProfiling(Boolean enableProfiling)
SyntheticsTestOptions	enableSecurityTesting(Boolean enableSecurityTesting)
boolean	equals(Object o) Return true if this SyntheticsTestOptions object is equal to o.
SyntheticsTestOptions	followRedirects(Boolean followRedirects)
Boolean	getAcceptSelfSigned() For SSL test, whether or not the test should allow self signed certificates.
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
Boolean	getAllowInsecure() Allows loading insecure content for an HTTP request in an API test.
Boolean	getCheckCertificateRevocation() For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
SyntheticsTestCiOptions	getCi() CI/CD options for a Synthetic test.
List<SyntheticsDeviceID>	getDeviceIds() For browser test, array with the different device IDs used to run the test.
Boolean	getDisableCors() Whether or not to disable CORS mechanism.
Boolean	getDisableCsp() Disable Content Security Policy for browser tests.
Boolean	getEnableProfiling() Enable profiling for browser tests.
Boolean	getEnableSecurityTesting() Deprecated.
Boolean	getFollowRedirects() For API HTTP test, whether or not the test should follow redirects.
SyntheticsTestOptionsHTTPVersion	getHttpVersion() HTTP version to use for a Synthetic test.
Boolean	getIgnoreServerCertificateError() Ignore server certificate error for browser tests.
Long	getInitialNavigationTimeout() Timeout before declaring the initial step as failed (in seconds) for browser tests.
Long	getMinFailureDuration() Minimum amount of time in failure required to trigger an alert.
Long	getMinLocationFailed() Minimum number of locations in failure required to trigger an alert.
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() Prevents saving screenshots of the steps.
List<String>	getRestrictedRoles() A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
SyntheticsTestOptionsRetry	getRetry() Object describing the retry strategy to apply to a Synthetic test.
SyntheticsBrowserTestRumSettings	getRumSettings() The RUM data collection settings for the Synthetic browser 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).
int	hashCode()
SyntheticsTestOptions	httpVersion(SyntheticsTestOptionsHTTPVersion httpVersion)
SyntheticsTestOptions	ignoreServerCertificateError(Boolean ignoreServerCertificateError)
SyntheticsTestOptions	initialNavigationTimeout(Long initialNavigationTimeout)
SyntheticsTestOptions	minFailureDuration(Long minFailureDuration)
SyntheticsTestOptions	minLocationFailed(Long minLocationFailed)
SyntheticsTestOptions	monitorName(String monitorName)
SyntheticsTestOptions	monitorOptions(SyntheticsTestOptionsMonitorOptions monitorOptions)
SyntheticsTestOptions	monitorPriority(Integer monitorPriority)
SyntheticsTestOptions	noScreenshot(Boolean noScreenshot)
SyntheticsTestOptions	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
SyntheticsTestOptions	restrictedRoles(List<String> restrictedRoles)
SyntheticsTestOptions	retry(SyntheticsTestOptionsRetry retry)
SyntheticsTestOptions	rumSettings(SyntheticsBrowserTestRumSettings rumSettings)
SyntheticsTestOptions	scheduling(SyntheticsTestOptionsScheduling scheduling)
void	setAcceptSelfSigned(Boolean acceptSelfSigned)
void	setAllowInsecure(Boolean allowInsecure)
void	setCheckCertificateRevocation(Boolean checkCertificateRevocation)
void	setCi(SyntheticsTestCiOptions ci)
void	setDeviceIds(List<SyntheticsDeviceID> deviceIds)
void	setDisableCors(Boolean disableCors)
void	setDisableCsp(Boolean disableCsp)
void	setEnableProfiling(Boolean enableProfiling)
void	setEnableSecurityTesting(Boolean enableSecurityTesting) Deprecated.
void	setFollowRedirects(Boolean followRedirects)
void	setHttpVersion(SyntheticsTestOptionsHTTPVersion httpVersion)
void	setIgnoreServerCertificateError(Boolean ignoreServerCertificateError)
void	setInitialNavigationTimeout(Long initialNavigationTimeout)
void	setMinFailureDuration(Long minFailureDuration)
void	setMinLocationFailed(Long minLocationFailed)
void	setMonitorName(String monitorName)
void	setMonitorOptions(SyntheticsTestOptionsMonitorOptions monitorOptions)
void	setMonitorPriority(Integer monitorPriority)
void	setNoScreenshot(Boolean noScreenshot)
void	setRestrictedRoles(List<String> restrictedRoles)
void	setRetry(SyntheticsTestOptionsRetry retry)
void	setRumSettings(SyntheticsBrowserTestRumSettings rumSettings)
void	setScheduling(SyntheticsTestOptionsScheduling scheduling)
void	setTickEvery(Long tickEvery)
SyntheticsTestOptions	tickEvery(Long tickEvery)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_ACCEPT_SELF_SIGNED

public static final String JSON_PROPERTY_ACCEPT_SELF_SIGNED

See Also:

Constant Field Values

JSON_PROPERTY_ALLOW_INSECURE

public static final String JSON_PROPERTY_ALLOW_INSECURE

See Also:

Constant Field Values

JSON_PROPERTY_CHECK_CERTIFICATE_REVOCATION

public static final String JSON_PROPERTY_CHECK_CERTIFICATE_REVOCATION

See Also:

Constant Field Values

JSON_PROPERTY_CI

public static final String JSON_PROPERTY_CI

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_CORS

public static final String JSON_PROPERTY_DISABLE_CORS

See Also:

Constant Field Values

JSON_PROPERTY_DISABLE_CSP

public static final String JSON_PROPERTY_DISABLE_CSP

See Also:

Constant Field Values

JSON_PROPERTY_ENABLE_PROFILING

public static final String JSON_PROPERTY_ENABLE_PROFILING

See Also:

Constant Field Values

JSON_PROPERTY_ENABLE_SECURITY_TESTING

public static final String JSON_PROPERTY_ENABLE_SECURITY_TESTING

See Also:

Constant Field Values

JSON_PROPERTY_FOLLOW_REDIRECTS

public static final String JSON_PROPERTY_FOLLOW_REDIRECTS

See Also:

Constant Field Values

JSON_PROPERTY_HTTP_VERSION

public static final String JSON_PROPERTY_HTTP_VERSION

See Also:

Constant Field Values

JSON_PROPERTY_IGNORE_SERVER_CERTIFICATE_ERROR

public static final String JSON_PROPERTY_IGNORE_SERVER_CERTIFICATE_ERROR

See Also:

Constant Field Values

JSON_PROPERTY_INITIAL_NAVIGATION_TIMEOUT

public static final String JSON_PROPERTY_INITIAL_NAVIGATION_TIMEOUT

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_MIN_LOCATION_FAILED

public static final String JSON_PROPERTY_MIN_LOCATION_FAILED

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_RUM_SETTINGS

public static final String JSON_PROPERTY_RUM_SETTINGS

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

Constructor Detail

SyntheticsTestOptions

public SyntheticsTestOptions()

Method Detail

acceptSelfSigned

public SyntheticsTestOptions acceptSelfSigned(Boolean acceptSelfSigned)

getAcceptSelfSigned

@Nullable
public Boolean getAcceptSelfSigned()

For SSL test, whether or not the test should allow self signed certificates.

Returns:

acceptSelfSigned

setAcceptSelfSigned

public void setAcceptSelfSigned(Boolean acceptSelfSigned)

allowInsecure

public SyntheticsTestOptions allowInsecure(Boolean allowInsecure)

getAllowInsecure

@Nullable
public Boolean getAllowInsecure()

Allows loading insecure content for an HTTP request in an API test.

Returns:

allowInsecure

setAllowInsecure

public void setAllowInsecure(Boolean allowInsecure)

checkCertificateRevocation

public SyntheticsTestOptions checkCertificateRevocation(Boolean checkCertificateRevocation)

getCheckCertificateRevocation

@Nullable
public Boolean getCheckCertificateRevocation()

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

Returns:

checkCertificateRevocation

setCheckCertificateRevocation

public void setCheckCertificateRevocation(Boolean checkCertificateRevocation)

ci

public SyntheticsTestOptions ci(SyntheticsTestCiOptions ci)

getCi

@Nullable
public SyntheticsTestCiOptions getCi()

CI/CD options for a Synthetic test.

Returns:

ci

setCi

public void setCi(SyntheticsTestCiOptions ci)

deviceIds

public SyntheticsTestOptions deviceIds(List<SyntheticsDeviceID> deviceIds)

addDeviceIdsItem

public SyntheticsTestOptions addDeviceIdsItem(SyntheticsDeviceID deviceIdsItem)

getDeviceIds

@Nullable
public List<SyntheticsDeviceID> getDeviceIds()

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

Returns:

deviceIds

setDeviceIds

public void setDeviceIds(List<SyntheticsDeviceID> deviceIds)

disableCors

public SyntheticsTestOptions disableCors(Boolean disableCors)

getDisableCors

@Nullable
public Boolean getDisableCors()

Whether or not to disable CORS mechanism.

Returns:

disableCors

setDisableCors

public void setDisableCors(Boolean disableCors)

disableCsp

public SyntheticsTestOptions disableCsp(Boolean disableCsp)

getDisableCsp

@Nullable
public Boolean getDisableCsp()

Disable Content Security Policy for browser tests.

Returns:

disableCsp

setDisableCsp

public void setDisableCsp(Boolean disableCsp)

enableProfiling

public SyntheticsTestOptions enableProfiling(Boolean enableProfiling)

getEnableProfiling

@Nullable
public Boolean getEnableProfiling()

Enable profiling for browser tests.

Returns:

enableProfiling

setEnableProfiling

public void setEnableProfiling(Boolean enableProfiling)

enableSecurityTesting

public SyntheticsTestOptions enableSecurityTesting(Boolean enableSecurityTesting)

getEnableSecurityTesting

@Deprecated
 @Nullable
public Boolean getEnableSecurityTesting()

Deprecated.

Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

Returns:

enableSecurityTesting

setEnableSecurityTesting

@Deprecated
public void setEnableSecurityTesting(Boolean enableSecurityTesting)

Deprecated.

followRedirects

public SyntheticsTestOptions followRedirects(Boolean followRedirects)

getFollowRedirects

@Nullable
public Boolean getFollowRedirects()

For API HTTP test, whether or not the test should follow redirects.

Returns:

followRedirects

setFollowRedirects

public void setFollowRedirects(Boolean followRedirects)

httpVersion

public SyntheticsTestOptions httpVersion(SyntheticsTestOptionsHTTPVersion httpVersion)

getHttpVersion

@Nullable
public SyntheticsTestOptionsHTTPVersion getHttpVersion()

HTTP version to use for a Synthetic test.

Returns:

httpVersion

setHttpVersion

public void setHttpVersion(SyntheticsTestOptionsHTTPVersion httpVersion)

ignoreServerCertificateError

public SyntheticsTestOptions ignoreServerCertificateError(Boolean ignoreServerCertificateError)

getIgnoreServerCertificateError

@Nullable
public Boolean getIgnoreServerCertificateError()

Ignore server certificate error for browser tests.

Returns:

ignoreServerCertificateError

setIgnoreServerCertificateError

public void setIgnoreServerCertificateError(Boolean ignoreServerCertificateError)

initialNavigationTimeout

public SyntheticsTestOptions initialNavigationTimeout(Long initialNavigationTimeout)

getInitialNavigationTimeout

@Nullable
public Long getInitialNavigationTimeout()

Timeout before declaring the initial step as failed (in seconds) for browser tests.

Returns:

initialNavigationTimeout

setInitialNavigationTimeout

public void setInitialNavigationTimeout(Long initialNavigationTimeout)

minFailureDuration

public SyntheticsTestOptions minFailureDuration(Long minFailureDuration)

getMinFailureDuration

@Nullable
public Long getMinFailureDuration()

Minimum amount of time in failure required to trigger an alert.

Returns:

minFailureDuration

setMinFailureDuration

public void setMinFailureDuration(Long minFailureDuration)

minLocationFailed

public SyntheticsTestOptions minLocationFailed(Long minLocationFailed)

getMinLocationFailed

@Nullable
public Long getMinLocationFailed()

Minimum number of locations in failure required to trigger an alert.

Returns:

minLocationFailed

setMinLocationFailed

public void setMinLocationFailed(Long minLocationFailed)

monitorName

public SyntheticsTestOptions 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 SyntheticsTestOptions 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 SyntheticsTestOptions 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 SyntheticsTestOptions noScreenshot(Boolean noScreenshot)

getNoScreenshot

@Nullable
public Boolean getNoScreenshot()

Prevents saving screenshots of the steps.

Returns:

noScreenshot

setNoScreenshot

public void setNoScreenshot(Boolean noScreenshot)

restrictedRoles

public SyntheticsTestOptions restrictedRoles(List<String> restrictedRoles)

addRestrictedRolesItem

public SyntheticsTestOptions addRestrictedRolesItem(String restrictedRolesItem)

getRestrictedRoles

@Nullable
public List<String> getRestrictedRoles()

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

Returns:

restrictedRoles

setRestrictedRoles

public void setRestrictedRoles(List<String> restrictedRoles)

retry

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

rumSettings

public SyntheticsTestOptions rumSettings(SyntheticsBrowserTestRumSettings rumSettings)

getRumSettings

@Nullable
public SyntheticsBrowserTestRumSettings getRumSettings()

The RUM data collection settings for the Synthetic browser test. Note: There are 3 ways to format RUM settings:

{ isEnabled: false } RUM data is not collected.

{ isEnabled: true } RUM data is collected from the Synthetic test's default application.

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 } RUM data is collected using the specified application.

Returns:

rumSettings

setRumSettings

public void setRumSettings(SyntheticsBrowserTestRumSettings rumSettings)

scheduling

public SyntheticsTestOptions 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 SyntheticsTestOptions tickEvery(Long tickEvery)

getTickEvery

@Nullable
public Long getTickEvery()

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

Returns:

tickEvery

setTickEvery

public void setTickEvery(Long tickEvery)

putAdditionalProperty

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

SyntheticsTestOptions

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