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

Class SyntheticsAPITest

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsAPITest

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

Object containing details about a Synthetic API test.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CONFIG
static final String	JSON_PROPERTY_LOCATIONS
static final String	JSON_PROPERTY_MESSAGE
static final String	JSON_PROPERTY_MONITOR_ID
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_OPTIONS
static final String	JSON_PROPERTY_PUBLIC_ID
static final String	JSON_PROPERTY_STATUS
static final String	JSON_PROPERTY_SUBTYPE
static final String	JSON_PROPERTY_TAGS
static final String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
SyntheticsAPITest()
SyntheticsAPITest(SyntheticsAPITestConfig config, List<String> locations, String message, String name, SyntheticsTestOptions options, SyntheticsAPITestType type)

Method Summary

Modifier and Type	Method	Description
SyntheticsAPITest	addLocationsItem(String locationsItem)
SyntheticsAPITest	addTagsItem(String tagsItem)
SyntheticsAPITest	config(SyntheticsAPITestConfig config)
boolean	equals(Object o)	Return true if this SyntheticsAPITest 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.
SyntheticsAPITestConfig	getConfig()	Configuration object for a Synthetic API test.
List<String>	getLocations()	Array of locations used to run the test.
String	getMessage()	Notification message associated with the test.
Long	getMonitorId()	The associated monitor ID.
String	getName()	Name of the test.
SyntheticsTestOptions	getOptions()	Object describing the extra options for a Synthetic test.
String	getPublicId()	The public ID for the test.
SyntheticsTestPauseStatus	getStatus()	Define whether you want to start (live) or pause (paused) a Synthetic test.
SyntheticsTestDetailsSubType	getSubtype()	The subtype of the Synthetic API test, http, ssl, tcp, dns, icmp, udp, websocket, grpc or multi.
List<String>	getTags()	Array of tags attached to the test.
SyntheticsAPITestType	getType()	Type of the Synthetic test, api.
int	hashCode()
SyntheticsAPITest	locations(List<String> locations)
SyntheticsAPITest	message(String message)
SyntheticsAPITest	name(String name)
SyntheticsAPITest	options(SyntheticsTestOptions options)
SyntheticsAPITest	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setConfig(SyntheticsAPITestConfig config)
void	setLocations(List<String> locations)
void	setMessage(String message)
void	setName(String name)
void	setOptions(SyntheticsTestOptions options)
void	setStatus(SyntheticsTestPauseStatus status)
void	setSubtype(SyntheticsTestDetailsSubType subtype)
void	setTags(List<String> tags)
void	setType(SyntheticsAPITestType type)
SyntheticsAPITest	status(SyntheticsTestPauseStatus status)
SyntheticsAPITest	subtype(SyntheticsTestDetailsSubType subtype)
SyntheticsAPITest	tags(List<String> tags)
String	toString()
SyntheticsAPITest	type(SyntheticsAPITestType type)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_CONFIG

public static final String JSON_PROPERTY_CONFIG

See Also:

• Constant Field Values

JSON_PROPERTY_LOCATIONS

public static final String JSON_PROPERTY_LOCATIONS

See Also:

• Constant Field Values

JSON_PROPERTY_MESSAGE

public static final String JSON_PROPERTY_MESSAGE

See Also:

• Constant Field Values

JSON_PROPERTY_MONITOR_ID

public static final String JSON_PROPERTY_MONITOR_ID

See Also:

• Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_OPTIONS

public static final String JSON_PROPERTY_OPTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_PUBLIC_ID

public static final String JSON_PROPERTY_PUBLIC_ID

See Also:

• Constant Field Values

JSON_PROPERTY_STATUS

public static final String JSON_PROPERTY_STATUS

See Also:

• Constant Field Values

JSON_PROPERTY_SUBTYPE

public static final String JSON_PROPERTY_SUBTYPE

See Also:

• Constant Field Values

JSON_PROPERTY_TAGS

public static final String JSON_PROPERTY_TAGS

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

Constructor Details

SyntheticsAPITest

public SyntheticsAPITest()

SyntheticsAPITest

public SyntheticsAPITest(SyntheticsAPITestConfig config,
 List<String> locations,
 String message,
 String name,
 SyntheticsTestOptions options,
 SyntheticsAPITestType type)

Method Details

config

public SyntheticsAPITest config(SyntheticsAPITestConfig config)

getConfig

public SyntheticsAPITestConfig getConfig()

Configuration object for a Synthetic API test.

Returns:

config

setConfig

public void setConfig(SyntheticsAPITestConfig config)

locations

public SyntheticsAPITest locations(List<String> locations)

addLocationsItem

public SyntheticsAPITest addLocationsItem(String locationsItem)

getLocations

public List<String> getLocations()

Array of locations used to run the test.

Returns:

locations

setLocations

public void setLocations(List<String> locations)

message

public SyntheticsAPITest message(String message)

getMessage

public String getMessage()

Notification message associated with the test.

Returns:

message

setMessage

public void setMessage(String message)

getMonitorId

@Nullable
public Long getMonitorId()

The associated monitor ID.

Returns:

monitorId

name

public SyntheticsAPITest name(String name)

getName

public String getName()

Name of the test.

Returns:

name

setName

public void setName(String name)

options

public SyntheticsAPITest options(SyntheticsTestOptions options)

getOptions

public SyntheticsTestOptions getOptions()

Object describing the extra options for a Synthetic test.

Returns:

options

setOptions

public void setOptions(SyntheticsTestOptions options)

getPublicId

@Nullable
public String getPublicId()

The public ID for the test.

Returns:

publicId

status

public SyntheticsAPITest status(SyntheticsTestPauseStatus status)

getStatus

@Nullable
public SyntheticsTestPauseStatus getStatus()

Define whether you want to start (live) or pause (paused) a Synthetic test.

Returns:

status

setStatus

public void setStatus(SyntheticsTestPauseStatus status)

subtype

public SyntheticsAPITest subtype(SyntheticsTestDetailsSubType subtype)

getSubtype

@Nullable
public SyntheticsTestDetailsSubType getSubtype()

The subtype of the Synthetic API test, http, ssl, tcp, dns, icmp, udp, websocket, grpc or multi.

Returns:

subtype

setSubtype

public void setSubtype(SyntheticsTestDetailsSubType subtype)

tags

public SyntheticsAPITest tags(List<String> tags)

addTagsItem

public SyntheticsAPITest addTagsItem(String tagsItem)

getTags

@Nullable
public List<String> getTags()

Array of tags attached to the test.

Returns:

tags

setTags

public void setTags(List<String> tags)

type

public SyntheticsAPITest type(SyntheticsAPITestType type)

getType

public SyntheticsAPITestType getType()

Type of the Synthetic test, api.

Returns:

type

setType

public void setType(SyntheticsAPITestType type)

putAdditionalProperty

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

SyntheticsAPITest

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