com.datadog.api.client.v2.model

Class SyntheticsNetworkTestRequest

java.lang.Object

com.datadog.api.client.v2.model.SyntheticsNetworkTestRequest

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

Object describing the request for a Network Path test.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_DESTINATION_SERVICE
static String	JSON_PROPERTY_E2E_QUERIES
static String	JSON_PROPERTY_HOST
static String	JSON_PROPERTY_MAX_TTL
static String	JSON_PROPERTY_PORT
static String	JSON_PROPERTY_SOURCE_SERVICE
static String	JSON_PROPERTY_TCP_METHOD
static String	JSON_PROPERTY_TIMEOUT
static String	JSON_PROPERTY_TRACEROUTE_QUERIES
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SyntheticsNetworkTestRequest()
SyntheticsNetworkTestRequest(Long e2eQueries, String host, Long maxTtl, Long tracerouteQueries)

Method Summary

Modifier and Type	Method and Description
SyntheticsNetworkTestRequest	destinationService(String destinationService)
SyntheticsNetworkTestRequest	e2eQueries(Long e2eQueries)
boolean	equals(Object o) Return true if this SyntheticsNetworkTestRequest 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.
String	getDestinationService() An optional label displayed for the destination host in the Network Path visualization.
Long	getE2eQueries() The number of packets sent to probe the destination to measure packet loss, latency and jitter.
String	getHost() Host name to query.
Long	getMaxTtl() The maximum time-to-live (max number of hops) used in outgoing probe packets.
Long	getPort() For TCP or UDP tests, the port to use when performing the test.
String	getSourceService() An optional label displayed for the source host in the Network Path visualization.
SyntheticsNetworkTestRequestTCPMethod	getTcpMethod() For TCP tests, the TCP traceroute strategy.
Long	getTimeout() Timeout in seconds.
Long	getTracerouteQueries() The number of traceroute path tracings.
int	hashCode()
SyntheticsNetworkTestRequest	host(String host)
SyntheticsNetworkTestRequest	maxTtl(Long maxTtl)
SyntheticsNetworkTestRequest	port(Long port)
SyntheticsNetworkTestRequest	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setDestinationService(String destinationService)
void	setE2eQueries(Long e2eQueries)
void	setHost(String host)
void	setMaxTtl(Long maxTtl)
void	setPort(Long port)
void	setSourceService(String sourceService)
void	setTcpMethod(SyntheticsNetworkTestRequestTCPMethod tcpMethod)
void	setTimeout(Long timeout)
void	setTracerouteQueries(Long tracerouteQueries)
SyntheticsNetworkTestRequest	sourceService(String sourceService)
SyntheticsNetworkTestRequest	tcpMethod(SyntheticsNetworkTestRequestTCPMethod tcpMethod)
SyntheticsNetworkTestRequest	timeout(Long timeout)
String	toString()
SyntheticsNetworkTestRequest	tracerouteQueries(Long tracerouteQueries)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_DESTINATION_SERVICE

public static final String JSON_PROPERTY_DESTINATION_SERVICE

See Also:

Constant Field Values

JSON_PROPERTY_E2E_QUERIES

public static final String JSON_PROPERTY_E2E_QUERIES

See Also:

Constant Field Values

JSON_PROPERTY_HOST

public static final String JSON_PROPERTY_HOST

See Also:

Constant Field Values

JSON_PROPERTY_MAX_TTL

public static final String JSON_PROPERTY_MAX_TTL

See Also:

Constant Field Values

JSON_PROPERTY_PORT

public static final String JSON_PROPERTY_PORT

See Also:

Constant Field Values

JSON_PROPERTY_SOURCE_SERVICE

public static final String JSON_PROPERTY_SOURCE_SERVICE

See Also:

Constant Field Values

JSON_PROPERTY_TCP_METHOD

public static final String JSON_PROPERTY_TCP_METHOD

See Also:

Constant Field Values

JSON_PROPERTY_TIMEOUT

public static final String JSON_PROPERTY_TIMEOUT

See Also:

Constant Field Values

JSON_PROPERTY_TRACEROUTE_QUERIES

public static final String JSON_PROPERTY_TRACEROUTE_QUERIES

See Also:

Constant Field Values

Constructor Detail

SyntheticsNetworkTestRequest

public SyntheticsNetworkTestRequest()

SyntheticsNetworkTestRequest

public SyntheticsNetworkTestRequest(Long e2eQueries,
                                    String host,
                                    Long maxTtl,
                                    Long tracerouteQueries)

Method Detail

destinationService

public SyntheticsNetworkTestRequest destinationService(String destinationService)

getDestinationService

@Nullable
public String getDestinationService()

An optional label displayed for the destination host in the Network Path visualization.

Returns:

destinationService

setDestinationService

public void setDestinationService(String destinationService)

e2eQueries

public SyntheticsNetworkTestRequest e2eQueries(Long e2eQueries)

getE2eQueries

public Long getE2eQueries()

The number of packets sent to probe the destination to measure packet loss, latency and jitter.

Returns:

e2eQueries

setE2eQueries

public void setE2eQueries(Long e2eQueries)

host

public SyntheticsNetworkTestRequest host(String host)

getHost

public String getHost()

Host name to query.

Returns:

host

setHost

public void setHost(String host)

maxTtl

public SyntheticsNetworkTestRequest maxTtl(Long maxTtl)

getMaxTtl

public Long getMaxTtl()

The maximum time-to-live (max number of hops) used in outgoing probe packets.

Returns:

maxTtl

setMaxTtl

public void setMaxTtl(Long maxTtl)

port

public SyntheticsNetworkTestRequest port(Long port)

getPort

@Nullable
public Long getPort()

For TCP or UDP tests, the port to use when performing the test. If not set on a UDP test, a random port is assigned, which may affect the results.

Returns:

port

setPort

public void setPort(Long port)

sourceService

public SyntheticsNetworkTestRequest sourceService(String sourceService)

getSourceService

@Nullable
public String getSourceService()

An optional label displayed for the source host in the Network Path visualization.

Returns:

sourceService

setSourceService

public void setSourceService(String sourceService)

tcpMethod

public SyntheticsNetworkTestRequest tcpMethod(SyntheticsNetworkTestRequestTCPMethod tcpMethod)

getTcpMethod

@Nullable
public SyntheticsNetworkTestRequestTCPMethod getTcpMethod()

For TCP tests, the TCP traceroute strategy.

Returns:

tcpMethod

setTcpMethod

public void setTcpMethod(SyntheticsNetworkTestRequestTCPMethod tcpMethod)

timeout

public SyntheticsNetworkTestRequest timeout(Long timeout)

getTimeout

@Nullable
public Long getTimeout()

Timeout in seconds.

Returns:

timeout

setTimeout

public void setTimeout(Long timeout)

tracerouteQueries

public SyntheticsNetworkTestRequest tracerouteQueries(Long tracerouteQueries)

getTracerouteQueries

public Long getTracerouteQueries()

The number of traceroute path tracings.

Returns:

tracerouteQueries

setTracerouteQueries

public void setTracerouteQueries(Long tracerouteQueries)

putAdditionalProperty

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

SyntheticsNetworkTestRequest

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