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

Class SyntheticsTestRequest

java.lang.Object
com.datadog.api.client.v1.model.SyntheticsTestRequest
@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator") public class SyntheticsTestRequest extends Object
Object describing the Synthetic test request.

  • Field Details

  • Constructor Details

    • SyntheticsTestRequest

      public SyntheticsTestRequest()

  • Method Details

    • 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 call to perform. Used by gRPC steps (healthcheck, unary) and MCP steps (init, tool_list, tool_call). Valid values depend on the parent step's subtype.
      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)

    • checkCertificateRevocation

      public SyntheticsTestRequest checkCertificateRevocation(Boolean checkCertificateRevocation)

    • getCheckCertificateRevocation

      @Nullable public Boolean getCheckCertificateRevocation()
      Check for certificate revocation.
      Returns:
      checkCertificateRevocation

    • setCheckCertificateRevocation

      public void setCheckCertificateRevocation(Boolean checkCertificateRevocation)

    • 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)

    • disableAiaIntermediateFetching

      public SyntheticsTestRequest disableAiaIntermediateFetching(Boolean disableAiaIntermediateFetching)

    • getDisableAiaIntermediateFetching

      @Nullable public Boolean getDisableAiaIntermediateFetching()
      Disable fetching intermediate certificates from AIA.
      Returns:
      disableAiaIntermediateFetching

    • setDisableAiaIntermediateFetching

      public void setDisableAiaIntermediateFetching(Boolean disableAiaIntermediateFetching)

    • 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(SyntheticsTestRequestDNSServerPort dnsServerPort)

    • getDnsServerPort

      @Nullable public SyntheticsTestRequestDNSServerPort getDnsServerPort()
      DNS server port to use for DNS tests.
      Returns:
      dnsServerPort

    • setDnsServerPort

      public void setDnsServerPort(SyntheticsTestRequestDNSServerPort 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. Only valid if bodyType is multipart/form-data.
      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)

    • form

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

    • putFormItem

      public SyntheticsTestRequest putFormItem(String key, String formItem)

    • getForm

      @Nullable public Map<String,String> getForm()
      Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
      Returns:
      form

    • setForm

      public void setForm(Map<String,String> form)

    • 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)

    • ignoreCertificateValidation

      public SyntheticsTestRequest ignoreCertificateValidation(Boolean ignoreCertificateValidation)

    • getIgnoreCertificateValidation

      @Nullable public Boolean getIgnoreCertificateValidation()
      For SSL tests, whether the test should ignore certificate validation.
      Returns:
      ignoreCertificateValidation

    • setIgnoreCertificateValidation

      public void setIgnoreCertificateValidation(Boolean ignoreCertificateValidation)

    • isMessageBase64Encoded

      public SyntheticsTestRequest isMessageBase64Encoded(Boolean isMessageBase64Encoded)

    • getIsMessageBase64Encoded

      @Nullable public Boolean getIsMessageBase64Encoded()
      Whether the message is base64 encoded.
      Returns:
      isMessageBase64Encoded

    • setIsMessageBase64Encoded

      public void setIsMessageBase64Encoded(Boolean isMessageBase64Encoded)

    • mcpProtocolVersion

      public SyntheticsTestRequest mcpProtocolVersion(SyntheticsMCPProtocolVersion mcpProtocolVersion)

    • getMcpProtocolVersion

      @Nullable public SyntheticsMCPProtocolVersion getMcpProtocolVersion()
      The MCP protocol version used by the step. See https://modelcontextprotocol.io/specification.
      Returns:
      mcpProtocolVersion

    • setMcpProtocolVersion

      public void setMcpProtocolVersion(SyntheticsMCPProtocolVersion mcpProtocolVersion)

    • 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(SyntheticsTestRequestPort port)

    • getPort

      @Nullable public SyntheticsTestRequestPort getPort()
      Port to use when performing the test.
      Returns:
      port

    • setPort

      public void setPort(SyntheticsTestRequestPort 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)

    • toolArgs

      public SyntheticsTestRequest toolArgs(Map<String,Object> toolArgs)

    • putToolArgsItem

      public SyntheticsTestRequest putToolArgsItem(String key, Object toolArgsItem)

    • getToolArgs

      @Nullable public Map<String,Object> getToolArgs()
      Arguments to pass to the MCP tool. Free-form object whose shape depends on the tool. Used when callType is tool_call.
      Returns:
      toolArgs

    • setToolArgs

      public void setToolArgs(Map<String,Object> toolArgs)

    • toolName

      public SyntheticsTestRequest toolName(String toolName)

    • getToolName

      @Nullable public String getToolName()
      The name of the MCP tool to call. Required when callType is tool_call .
      Returns:
      toolName

    • setToolName

      public void setToolName(String toolName)

    • 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