com.datadog.api.client.v1.model

Class SyntheticsTestRequest

java.lang.Object

com.datadog.api.client.v1.model.SyntheticsTestRequest

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

Object describing the Synthetic test request.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ALLOW_INSECURE
static String	JSON_PROPERTY_BASIC_AUTH
static String	JSON_PROPERTY_BODY
static String	JSON_PROPERTY_BODY_TYPE
static String	JSON_PROPERTY_CALL_TYPE
static String	JSON_PROPERTY_CERTIFICATE
static String	JSON_PROPERTY_CERTIFICATE_DOMAINS
static String	JSON_PROPERTY_COMPRESSED_JSON_DESCRIPTOR
static String	JSON_PROPERTY_COMPRESSED_PROTO_FILE
static String	JSON_PROPERTY_DNS_SERVER
static String	JSON_PROPERTY_DNS_SERVER_PORT
static String	JSON_PROPERTY_FILES
static String	JSON_PROPERTY_FOLLOW_REDIRECTS
static String	JSON_PROPERTY_HEADERS
static String	JSON_PROPERTY_HOST
static String	JSON_PROPERTY_HTTP_VERSION
static String	JSON_PROPERTY_MESSAGE
static String	JSON_PROPERTY_METADATA
static String	JSON_PROPERTY_METHOD
static String	JSON_PROPERTY_NO_SAVING_RESPONSE_BODY
static String	JSON_PROPERTY_NUMBER_OF_PACKETS
static String	JSON_PROPERTY_PERSIST_COOKIES
static String	JSON_PROPERTY_PORT
static String	JSON_PROPERTY_PROXY
static String	JSON_PROPERTY_QUERY
static String	JSON_PROPERTY_SERVERNAME
static String	JSON_PROPERTY_SERVICE
static String	JSON_PROPERTY_SHOULD_TRACK_HOPS
static String	JSON_PROPERTY_TIMEOUT
static String	JSON_PROPERTY_URL
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SyntheticsTestRequest()

Method Summary

Modifier and Type	Method and Description
SyntheticsTestRequest	addCertificateDomainsItem(String certificateDomainsItem)
SyntheticsTestRequest	addFilesItem(SyntheticsTestRequestBodyFile filesItem)
SyntheticsTestRequest	allowInsecure(Boolean allowInsecure)
SyntheticsTestRequest	basicAuth(SyntheticsBasicAuth basicAuth)
SyntheticsTestRequest	body(String body)
SyntheticsTestRequest	bodyType(SyntheticsTestRequestBodyType bodyType)
SyntheticsTestRequest	callType(SyntheticsTestCallType callType)
SyntheticsTestRequest	certificate(SyntheticsTestRequestCertificate certificate)
SyntheticsTestRequest	certificateDomains(List<String> certificateDomains)
SyntheticsTestRequest	compressedJsonDescriptor(String compressedJsonDescriptor)
SyntheticsTestRequest	compressedProtoFile(String compressedProtoFile)
SyntheticsTestRequest	dnsServer(String dnsServer)
SyntheticsTestRequest	dnsServerPort(Integer dnsServerPort)
boolean	equals(Object o) Return true if this SyntheticsTestRequest object is equal to o.
SyntheticsTestRequest	files(List<SyntheticsTestRequestBodyFile> files)
SyntheticsTestRequest	followRedirects(Boolean followRedirects)
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 a multistep test step.
SyntheticsBasicAuth	getBasicAuth() Object to handle basic authentication when performing the test.
String	getBody() Body to include in the test.
SyntheticsTestRequestBodyType	getBodyType() Type of the request body.
SyntheticsTestCallType	getCallType() The type of gRPC call to perform.
SyntheticsTestRequestCertificate	getCertificate() Client certificate to use when performing the test request.
List<String>	getCertificateDomains() By default, the client certificate is applied on the domain of the starting URL for browser tests.
String	getCompressedJsonDescriptor() A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
String	getCompressedProtoFile() A protobuf file that needs to be gzipped first then base64 encoded.
String	getDnsServer() DNS server to use for DNS tests.
Integer	getDnsServerPort() DNS server port to use for DNS tests.
List<SyntheticsTestRequestBodyFile>	getFiles() Files to be used as part of the request in the test.
Boolean	getFollowRedirects() Specifies whether or not the request follows redirects.
Map<String,String>	getHeaders() Headers to include when performing the test.
String	getHost() Host name to perform the test with.
SyntheticsTestOptionsHTTPVersion	getHttpVersion() HTTP version to use for a Synthetic test.
String	getMessage() Message to send for UDP or WebSocket tests.
Map<String,String>	getMetadata() Metadata to include when performing the gRPC test.
String	getMethod() Either the HTTP method/verb to use or a gRPC method available on the service set in the service field.
Boolean	getNoSavingResponseBody() Determines whether or not to save the response body.
Integer	getNumberOfPackets() Number of pings to use per test.
Boolean	getPersistCookies() Persist cookies across redirects.
Long	getPort() Port to use when performing the test.
SyntheticsTestRequestProxy	getProxy() The proxy to perform the test.
Object	getQuery() Query to use for the test.
String	getServername() For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
String	getService() The gRPC service on which you want to perform the gRPC call.
Boolean	getShouldTrackHops() Turns on a traceroute probe to discover all gateways along the path to the host destination.
Double	getTimeout() Timeout in seconds for the test.
String	getUrl() URL to perform the test with.
int	hashCode()
SyntheticsTestRequest	headers(Map<String,String> headers)
SyntheticsTestRequest	host(String host)
SyntheticsTestRequest	httpVersion(SyntheticsTestOptionsHTTPVersion httpVersion)
SyntheticsTestRequest	message(String message)
SyntheticsTestRequest	metadata(Map<String,String> metadata)
SyntheticsTestRequest	method(String method)
SyntheticsTestRequest	noSavingResponseBody(Boolean noSavingResponseBody)
SyntheticsTestRequest	numberOfPackets(Integer numberOfPackets)
SyntheticsTestRequest	persistCookies(Boolean persistCookies)
SyntheticsTestRequest	port(Long port)
SyntheticsTestRequest	proxy(SyntheticsTestRequestProxy proxy)
SyntheticsTestRequest	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
SyntheticsTestRequest	putHeadersItem(String key, String headersItem)
SyntheticsTestRequest	putMetadataItem(String key, String metadataItem)
SyntheticsTestRequest	query(Object query)
SyntheticsTestRequest	servername(String servername)
SyntheticsTestRequest	service(String service)
void	setAllowInsecure(Boolean allowInsecure)
void	setBasicAuth(SyntheticsBasicAuth basicAuth)
void	setBody(String body)
void	setBodyType(SyntheticsTestRequestBodyType bodyType)
void	setCallType(SyntheticsTestCallType callType)
void	setCertificate(SyntheticsTestRequestCertificate certificate)
void	setCertificateDomains(List<String> certificateDomains)
void	setCompressedJsonDescriptor(String compressedJsonDescriptor)
void	setCompressedProtoFile(String compressedProtoFile)
void	setDnsServer(String dnsServer)
void	setDnsServerPort(Integer dnsServerPort)
void	setFiles(List<SyntheticsTestRequestBodyFile> files)
void	setFollowRedirects(Boolean followRedirects)
void	setHeaders(Map<String,String> headers)
void	setHost(String host)
void	setHttpVersion(SyntheticsTestOptionsHTTPVersion httpVersion)
void	setMessage(String message)
void	setMetadata(Map<String,String> metadata)
void	setMethod(String method)
void	setNoSavingResponseBody(Boolean noSavingResponseBody)
void	setNumberOfPackets(Integer numberOfPackets)
void	setPersistCookies(Boolean persistCookies)
void	setPort(Long port)
void	setProxy(SyntheticsTestRequestProxy proxy)
void	setQuery(Object query)
void	setServername(String servername)
void	setService(String service)
void	setShouldTrackHops(Boolean shouldTrackHops)
void	setTimeout(Double timeout)
void	setUrl(String url)
SyntheticsTestRequest	shouldTrackHops(Boolean shouldTrackHops)
SyntheticsTestRequest	timeout(Double timeout)
String	toString()
SyntheticsTestRequest	url(String url)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_ALLOW_INSECURE

public static final String JSON_PROPERTY_ALLOW_INSECURE

See Also:

Constant Field Values

JSON_PROPERTY_BASIC_AUTH

public static final String JSON_PROPERTY_BASIC_AUTH

See Also:

Constant Field Values

JSON_PROPERTY_BODY

public static final String JSON_PROPERTY_BODY

See Also:

Constant Field Values

JSON_PROPERTY_BODY_TYPE

public static final String JSON_PROPERTY_BODY_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_CALL_TYPE

public static final String JSON_PROPERTY_CALL_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_CERTIFICATE

public static final String JSON_PROPERTY_CERTIFICATE

See Also:

Constant Field Values

JSON_PROPERTY_CERTIFICATE_DOMAINS

public static final String JSON_PROPERTY_CERTIFICATE_DOMAINS

See Also:

Constant Field Values

JSON_PROPERTY_COMPRESSED_JSON_DESCRIPTOR

public static final String JSON_PROPERTY_COMPRESSED_JSON_DESCRIPTOR

See Also:

Constant Field Values

JSON_PROPERTY_COMPRESSED_PROTO_FILE

public static final String JSON_PROPERTY_COMPRESSED_PROTO_FILE

See Also:

Constant Field Values

JSON_PROPERTY_DNS_SERVER

public static final String JSON_PROPERTY_DNS_SERVER

See Also:

Constant Field Values

JSON_PROPERTY_DNS_SERVER_PORT

public static final String JSON_PROPERTY_DNS_SERVER_PORT

See Also:

Constant Field Values

JSON_PROPERTY_FILES

public static final String JSON_PROPERTY_FILES

See Also:

Constant Field Values

JSON_PROPERTY_FOLLOW_REDIRECTS

public static final String JSON_PROPERTY_FOLLOW_REDIRECTS

See Also:

Constant Field Values

JSON_PROPERTY_HEADERS

public static final String JSON_PROPERTY_HEADERS

See Also:

Constant Field Values

JSON_PROPERTY_HOST

public static final String JSON_PROPERTY_HOST

See Also:

Constant Field Values

JSON_PROPERTY_HTTP_VERSION

public static final String JSON_PROPERTY_HTTP_VERSION

See Also:

Constant Field Values

JSON_PROPERTY_MESSAGE

public static final String JSON_PROPERTY_MESSAGE

See Also:

Constant Field Values

JSON_PROPERTY_METADATA

public static final String JSON_PROPERTY_METADATA

See Also:

Constant Field Values

JSON_PROPERTY_METHOD

public static final String JSON_PROPERTY_METHOD

See Also:

Constant Field Values

JSON_PROPERTY_NO_SAVING_RESPONSE_BODY

public static final String JSON_PROPERTY_NO_SAVING_RESPONSE_BODY

See Also:

Constant Field Values

JSON_PROPERTY_NUMBER_OF_PACKETS

public static final String JSON_PROPERTY_NUMBER_OF_PACKETS

See Also:

Constant Field Values

JSON_PROPERTY_PERSIST_COOKIES

public static final String JSON_PROPERTY_PERSIST_COOKIES

See Also:

Constant Field Values

JSON_PROPERTY_PORT

public static final String JSON_PROPERTY_PORT

See Also:

Constant Field Values

JSON_PROPERTY_PROXY

public static final String JSON_PROPERTY_PROXY

See Also:

Constant Field Values

JSON_PROPERTY_QUERY

public static final String JSON_PROPERTY_QUERY

See Also:

Constant Field Values

JSON_PROPERTY_SERVERNAME

public static final String JSON_PROPERTY_SERVERNAME

See Also:

Constant Field Values

JSON_PROPERTY_SERVICE

public static final String JSON_PROPERTY_SERVICE

See Also:

Constant Field Values

JSON_PROPERTY_SHOULD_TRACK_HOPS

public static final String JSON_PROPERTY_SHOULD_TRACK_HOPS

See Also:

Constant Field Values

JSON_PROPERTY_TIMEOUT

public static final String JSON_PROPERTY_TIMEOUT

See Also:

Constant Field Values

JSON_PROPERTY_URL

public static final String JSON_PROPERTY_URL

See Also:

Constant Field Values

Constructor Detail

SyntheticsTestRequest

public SyntheticsTestRequest()

Method Detail

allowInsecure

public SyntheticsTestRequest allowInsecure(Boolean allowInsecure)

getAllowInsecure

@Nullable
public Boolean getAllowInsecure()

Allows loading insecure content for an HTTP request in a multistep test step.

Returns:

allowInsecure

setAllowInsecure

public void setAllowInsecure(Boolean allowInsecure)

basicAuth

public SyntheticsTestRequest basicAuth(SyntheticsBasicAuth basicAuth)

getBasicAuth

@Nullable
public SyntheticsBasicAuth getBasicAuth()

Object to handle basic authentication when performing the test.

Returns:

basicAuth

setBasicAuth

public void setBasicAuth(SyntheticsBasicAuth basicAuth)

body

public SyntheticsTestRequest body(String body)

getBody

@Nullable
public String getBody()

Body to include in the test.

Returns:

body

setBody

public void setBody(String body)

bodyType

public SyntheticsTestRequest bodyType(SyntheticsTestRequestBodyType bodyType)

getBodyType

@Nullable
public SyntheticsTestRequestBodyType getBodyType()

Type of the request body.

Returns:

bodyType

setBodyType

public void setBodyType(SyntheticsTestRequestBodyType bodyType)

callType

public SyntheticsTestRequest callType(SyntheticsTestCallType callType)

getCallType

@Nullable
public SyntheticsTestCallType getCallType()

The type of gRPC call to perform.

Returns:

callType

setCallType

public void setCallType(SyntheticsTestCallType callType)

certificate

public SyntheticsTestRequest certificate(SyntheticsTestRequestCertificate certificate)

getCertificate

@Nullable
public SyntheticsTestRequestCertificate getCertificate()

Client certificate to use when performing the test request.

Returns:

certificate

setCertificate

public void setCertificate(SyntheticsTestRequestCertificate certificate)

certificateDomains

public SyntheticsTestRequest certificateDomains(List<String> certificateDomains)

addCertificateDomainsItem

public SyntheticsTestRequest addCertificateDomainsItem(String certificateDomainsItem)

getCertificateDomains

@Nullable
public List<String> getCertificateDomains()

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

Returns:

certificateDomains

setCertificateDomains

public void setCertificateDomains(List<String> certificateDomains)

compressedJsonDescriptor

public SyntheticsTestRequest compressedJsonDescriptor(String compressedJsonDescriptor)

getCompressedJsonDescriptor

@Nullable
public String getCompressedJsonDescriptor()

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

Returns:

compressedJsonDescriptor

setCompressedJsonDescriptor

public void setCompressedJsonDescriptor(String compressedJsonDescriptor)

compressedProtoFile

public SyntheticsTestRequest compressedProtoFile(String compressedProtoFile)

getCompressedProtoFile

@Nullable
public String getCompressedProtoFile()

A protobuf file that needs to be gzipped first then base64 encoded.

Returns:

compressedProtoFile

setCompressedProtoFile

public void setCompressedProtoFile(String compressedProtoFile)

dnsServer

public SyntheticsTestRequest dnsServer(String dnsServer)

getDnsServer

@Nullable
public String getDnsServer()

DNS server to use for DNS tests.

Returns:

dnsServer

setDnsServer

public void setDnsServer(String dnsServer)

dnsServerPort

public SyntheticsTestRequest dnsServerPort(Integer dnsServerPort)

getDnsServerPort

@Nullable
public Integer getDnsServerPort()

DNS server port to use for DNS tests. minimum: 1 maximum: 65535

Returns:

dnsServerPort

setDnsServerPort

public void setDnsServerPort(Integer dnsServerPort)

files

public SyntheticsTestRequest files(List<SyntheticsTestRequestBodyFile> files)

addFilesItem

public SyntheticsTestRequest addFilesItem(SyntheticsTestRequestBodyFile filesItem)

getFiles

@Nullable
public List<SyntheticsTestRequestBodyFile> getFiles()

Files to be used as part of the request in the test.

Returns:

files

setFiles

public void setFiles(List<SyntheticsTestRequestBodyFile> files)

followRedirects

public SyntheticsTestRequest followRedirects(Boolean followRedirects)

getFollowRedirects

@Nullable
public Boolean getFollowRedirects()

Specifies whether or not the request follows redirects.

Returns:

followRedirects

setFollowRedirects

public void setFollowRedirects(Boolean followRedirects)

headers

public SyntheticsTestRequest headers(Map<String,String> headers)

putHeadersItem

public SyntheticsTestRequest putHeadersItem(String key,
                                            String headersItem)

getHeaders

@Nullable
public Map<String,String> getHeaders()

Headers to include when performing the test.

Returns:

headers

setHeaders

public void setHeaders(Map<String,String> headers)

host

public SyntheticsTestRequest host(String host)

getHost

@Nullable
public String getHost()

Host name to perform the test with.

Returns:

host

setHost

public void setHost(String host)

httpVersion

public SyntheticsTestRequest httpVersion(SyntheticsTestOptionsHTTPVersion httpVersion)

getHttpVersion

@Nullable
public SyntheticsTestOptionsHTTPVersion getHttpVersion()

HTTP version to use for a Synthetic test.

Returns:

httpVersion

setHttpVersion

public void setHttpVersion(SyntheticsTestOptionsHTTPVersion httpVersion)

message

public SyntheticsTestRequest message(String message)

getMessage

@Nullable
public String getMessage()

Message to send for UDP or WebSocket tests.

Returns:

message

setMessage

public void setMessage(String message)

metadata

public SyntheticsTestRequest metadata(Map<String,String> metadata)

putMetadataItem

public SyntheticsTestRequest putMetadataItem(String key,
                                             String metadataItem)

getMetadata

@Nullable
public Map<String,String> getMetadata()

Metadata to include when performing the gRPC test.

Returns:

metadata

setMetadata

public void setMetadata(Map<String,String> metadata)

method

public SyntheticsTestRequest method(String method)

getMethod

@Nullable
public String getMethod()

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

Returns:

method

setMethod

public void setMethod(String method)

noSavingResponseBody

public SyntheticsTestRequest noSavingResponseBody(Boolean noSavingResponseBody)

getNoSavingResponseBody

@Nullable
public Boolean getNoSavingResponseBody()

Determines whether or not to save the response body.

Returns:

noSavingResponseBody

setNoSavingResponseBody

public void setNoSavingResponseBody(Boolean noSavingResponseBody)

numberOfPackets

public SyntheticsTestRequest numberOfPackets(Integer numberOfPackets)

getNumberOfPackets

@Nullable
public Integer getNumberOfPackets()

Number of pings to use per test. minimum: 0 maximum: 10

Returns:

numberOfPackets

setNumberOfPackets

public void setNumberOfPackets(Integer numberOfPackets)

persistCookies

public SyntheticsTestRequest persistCookies(Boolean persistCookies)

getPersistCookies

@Nullable
public Boolean getPersistCookies()

Persist cookies across redirects.

Returns:

persistCookies

setPersistCookies

public void setPersistCookies(Boolean persistCookies)

port

public SyntheticsTestRequest port(Long port)

getPort

@Nullable
public Long getPort()

Port to use when performing the test.

Returns:

port

setPort

public void setPort(Long port)

proxy

public SyntheticsTestRequest proxy(SyntheticsTestRequestProxy proxy)

getProxy

@Nullable
public SyntheticsTestRequestProxy getProxy()

The proxy to perform the test.

Returns:

proxy

setProxy

public void setProxy(SyntheticsTestRequestProxy proxy)

query

public SyntheticsTestRequest query(Object query)

getQuery

@Nullable
public Object getQuery()

Query to use for the test.

Returns:

query

setQuery

public void setQuery(Object query)

servername

public SyntheticsTestRequest servername(String servername)

getServername

@Nullable
public String getServername()

For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

Returns:

servername

setServername

public void setServername(String servername)

service

public SyntheticsTestRequest service(String service)

getService

@Nullable
public String getService()

The gRPC service on which you want to perform the gRPC call.

Returns:

service

setService

public void setService(String service)

shouldTrackHops

public SyntheticsTestRequest shouldTrackHops(Boolean shouldTrackHops)

getShouldTrackHops

@Nullable
public Boolean getShouldTrackHops()

Turns on a traceroute probe to discover all gateways along the path to the host destination.

Returns:

shouldTrackHops

setShouldTrackHops

public void setShouldTrackHops(Boolean shouldTrackHops)

timeout

public SyntheticsTestRequest timeout(Double timeout)

getTimeout

@Nullable
public Double getTimeout()

Timeout in seconds for the test.

Returns:

timeout

setTimeout

public void setTimeout(Double timeout)

url

public SyntheticsTestRequest url(String url)

getUrl

@Nullable
public String getUrl()

URL to perform the test with.

Returns:

url

setUrl

public void setUrl(String url)

putAdditionalProperty

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

SyntheticsTestRequest

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