com.datadog.api.client.v1.model

Class SyntheticsTestDetails

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsTestDetails

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

Object containing details about your Synthetic test.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SyntheticsTestDetails()

Method Summary

Modifier and Type	Method and Description
SyntheticsTestDetails	addLocationsItem(String locationsItem)
SyntheticsTestDetails	addStepsItem(SyntheticsStep stepsItem)
SyntheticsTestDetails	addTagsItem(String tagsItem)
SyntheticsTestDetails	config(SyntheticsTestConfig config)
boolean	equals(Object o) Return true if this SyntheticsTestDetails 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.
SyntheticsTestConfig	getConfig() Configuration object for a Synthetic test.
Creator	getCreator() Object describing the creator of the shared element.
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 test public ID.
SyntheticsTestPauseStatus	getStatus() Define whether you want to start (live) or pause (paused) a Synthetic test.
List<SyntheticsStep>	getSteps() For browser test, the steps of the 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.
SyntheticsTestDetailsType	getType() Type of the Synthetic test, either api or browser.
int	hashCode()
SyntheticsTestDetails	locations(List<String> locations)
SyntheticsTestDetails	message(String message)
SyntheticsTestDetails	name(String name)
SyntheticsTestDetails	options(SyntheticsTestOptions options)
SyntheticsTestDetails	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setConfig(SyntheticsTestConfig config)
void	setLocations(List<String> locations)
void	setMessage(String message)
void	setName(String name)
void	setOptions(SyntheticsTestOptions options)
void	setStatus(SyntheticsTestPauseStatus status)
void	setSteps(List<SyntheticsStep> steps)
void	setSubtype(SyntheticsTestDetailsSubType subtype)
void	setTags(List<String> tags)
void	setType(SyntheticsTestDetailsType type)
SyntheticsTestDetails	status(SyntheticsTestPauseStatus status)
SyntheticsTestDetails	steps(List<SyntheticsStep> steps)
SyntheticsTestDetails	subtype(SyntheticsTestDetailsSubType subtype)
SyntheticsTestDetails	tags(List<String> tags)
String	toString()
SyntheticsTestDetails	type(SyntheticsTestDetailsType type)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_CONFIG

public static final String JSON_PROPERTY_CONFIG

See Also:

Constant Field Values

JSON_PROPERTY_CREATOR

public static final String JSON_PROPERTY_CREATOR

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_STEPS

public static final String JSON_PROPERTY_STEPS

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 Detail

SyntheticsTestDetails

public SyntheticsTestDetails()

Method Detail

config

public SyntheticsTestDetails config(SyntheticsTestConfig config)

getConfig

@Nullable
public SyntheticsTestConfig getConfig()

Configuration object for a Synthetic test.

Returns:

config

setConfig

public void setConfig(SyntheticsTestConfig config)

getCreator

@Nullable
public Creator getCreator()

Object describing the creator of the shared element.

Returns:

creator

locations

public SyntheticsTestDetails locations(List<String> locations)

addLocationsItem

public SyntheticsTestDetails addLocationsItem(String locationsItem)

getLocations

@Nullable
public List<String> getLocations()

Array of locations used to run the test.

Returns:

locations

setLocations

public void setLocations(List<String> locations)

message

public SyntheticsTestDetails message(String message)

getMessage

@Nullable
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 SyntheticsTestDetails name(String name)

getName

@Nullable
public String getName()

Name of the test.

Returns:

name

setName

public void setName(String name)

options

public SyntheticsTestDetails options(SyntheticsTestOptions options)

getOptions

@Nullable
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 test public ID.

Returns:

publicId

status

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

steps

public SyntheticsTestDetails steps(List<SyntheticsStep> steps)

addStepsItem

public SyntheticsTestDetails addStepsItem(SyntheticsStep stepsItem)

getSteps

@Nullable
public List<SyntheticsStep> getSteps()

For browser test, the steps of the test.

Returns:

steps

setSteps

public void setSteps(List<SyntheticsStep> steps)

subtype

public SyntheticsTestDetails 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 SyntheticsTestDetails tags(List<String> tags)

addTagsItem

public SyntheticsTestDetails 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 SyntheticsTestDetails type(SyntheticsTestDetailsType type)

getType

@Nullable
public SyntheticsTestDetailsType getType()

Type of the Synthetic test, either api or browser.

Returns:

type

setType

public void setType(SyntheticsTestDetailsType type)

putAdditionalProperty

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

SyntheticsTestDetails

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