com.datadog.api.client.v2.model

Class SyntheticsTestOptions

java.lang.Object

com.datadog.api.client.v2.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_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_RESTRICTED_ROLES
static String	JSON_PROPERTY_RETRY
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	addRestrictedRolesItem(String restrictedRolesItem)
boolean	equals(Object o) Return true if this SyntheticsTestOptions 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.
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.
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).
int	hashCode()
SyntheticsTestOptions	minFailureDuration(Long minFailureDuration)
SyntheticsTestOptions	minLocationFailed(Long minLocationFailed)
SyntheticsTestOptions	monitorName(String monitorName)
SyntheticsTestOptions	monitorOptions(SyntheticsTestOptionsMonitorOptions monitorOptions)
SyntheticsTestOptions	monitorPriority(Integer monitorPriority)
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	scheduling(SyntheticsTestOptionsScheduling scheduling)
void	setMinFailureDuration(Long minFailureDuration)
void	setMinLocationFailed(Long minLocationFailed)
void	setMonitorName(String monitorName)
void	setMonitorOptions(SyntheticsTestOptionsMonitorOptions monitorOptions)
void	setMonitorPriority(Integer monitorPriority)
void	setRestrictedRoles(List<String> restrictedRoles) Deprecated.
void	setRetry(SyntheticsTestOptionsRetry retry)
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_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_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

Constructor Detail

SyntheticsTestOptions

public SyntheticsTestOptions()

Method Detail

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)

restrictedRoles

public SyntheticsTestOptions restrictedRoles(List<String> restrictedRoles)

addRestrictedRolesItem

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

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