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

Class SyntheticsTestOptions

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

  • Field Details

  • Constructor Details

    • SyntheticsTestOptions

      public SyntheticsTestOptions()

  • Method Details

    • acceptSelfSigned

      public SyntheticsTestOptions acceptSelfSigned(Boolean acceptSelfSigned)

    • getAcceptSelfSigned

      @Nullable public Boolean getAcceptSelfSigned()
      For SSL tests, whether or not the test should allow self signed certificates.
      Returns:
      acceptSelfSigned

    • setAcceptSelfSigned

      public void setAcceptSelfSigned(Boolean acceptSelfSigned)

    • allowInsecure

      public SyntheticsTestOptions allowInsecure(Boolean allowInsecure)

    • getAllowInsecure

      @Nullable public Boolean getAllowInsecure()
      Allows loading insecure content for an HTTP request in an API test.
      Returns:
      allowInsecure

    • setAllowInsecure

      public void setAllowInsecure(Boolean allowInsecure)

    • blockedRequestPatterns

      public SyntheticsTestOptions blockedRequestPatterns(List<String> blockedRequestPatterns)

    • addBlockedRequestPatternsItem

      public SyntheticsTestOptions addBlockedRequestPatternsItem(String blockedRequestPatternsItem)

    • getBlockedRequestPatterns

      @Nullable public List<String> getBlockedRequestPatterns()
      Array of URL patterns to block.
      Returns:
      blockedRequestPatterns

    • setBlockedRequestPatterns

      public void setBlockedRequestPatterns(List<String> blockedRequestPatterns)

    • captureNetworkPayloads

      public SyntheticsTestOptions captureNetworkPayloads(Boolean captureNetworkPayloads)

    • getCaptureNetworkPayloads

      @Nullable public Boolean getCaptureNetworkPayloads()
      Capture HTTP request/response headers and bodies for Fetch/XHR calls made during browser tests.
      Returns:
      captureNetworkPayloads

    • setCaptureNetworkPayloads

      public void setCaptureNetworkPayloads(Boolean captureNetworkPayloads)

    • checkCertificateRevocation

      public SyntheticsTestOptions checkCertificateRevocation(Boolean checkCertificateRevocation)

    • getCheckCertificateRevocation

      @Nullable public Boolean getCheckCertificateRevocation()
      For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
      Returns:
      checkCertificateRevocation

    • setCheckCertificateRevocation

      public void setCheckCertificateRevocation(Boolean checkCertificateRevocation)

    • ci

      public SyntheticsTestOptions ci(SyntheticsTestCiOptions ci)

    • getCi

      @Nullable public SyntheticsTestCiOptions getCi()
      CI/CD options for a Synthetic test.
      Returns:
      ci

    • setCi

      public void setCi(SyntheticsTestCiOptions ci)

    • deviceIds

      public SyntheticsTestOptions deviceIds(List<String> deviceIds)

    • addDeviceIdsItem

      public SyntheticsTestOptions addDeviceIdsItem(String deviceIdsItem)

    • getDeviceIds

      @Nullable public List<String> getDeviceIds()
      For browser test, array with the different device IDs used to run the test.
      Returns:
      deviceIds

    • setDeviceIds

      public void setDeviceIds(List<String> deviceIds)

    • disableAiaIntermediateFetching

      public SyntheticsTestOptions disableAiaIntermediateFetching(Boolean disableAiaIntermediateFetching)

    • getDisableAiaIntermediateFetching

      @Nullable public Boolean getDisableAiaIntermediateFetching()
      For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
      Returns:
      disableAiaIntermediateFetching

    • setDisableAiaIntermediateFetching

      public void setDisableAiaIntermediateFetching(Boolean disableAiaIntermediateFetching)

    • disableCors

      public SyntheticsTestOptions disableCors(Boolean disableCors)

    • getDisableCors

      @Nullable public Boolean getDisableCors()
      Whether or not to disable CORS mechanism.
      Returns:
      disableCors

    • setDisableCors

      public void setDisableCors(Boolean disableCors)

    • disableCsp

      public SyntheticsTestOptions disableCsp(Boolean disableCsp)

    • getDisableCsp

      @Nullable public Boolean getDisableCsp()
      Disable Content Security Policy for browser tests.
      Returns:
      disableCsp

    • setDisableCsp

      public void setDisableCsp(Boolean disableCsp)

    • enableProfiling

      public SyntheticsTestOptions enableProfiling(Boolean enableProfiling)

    • getEnableProfiling

      @Nullable public Boolean getEnableProfiling()
      Enable profiling for browser tests.
      Returns:
      enableProfiling

    • setEnableProfiling

      public void setEnableProfiling(Boolean enableProfiling)

    • enableSecurityTesting

      public SyntheticsTestOptions enableSecurityTesting(Boolean enableSecurityTesting)

    • getEnableSecurityTesting

      @Deprecated @Nullable public Boolean getEnableSecurityTesting()
      Deprecated.
      Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
      Returns:
      enableSecurityTesting

    • setEnableSecurityTesting

      @Deprecated public void setEnableSecurityTesting(Boolean enableSecurityTesting)
      Deprecated.

    • followRedirects

      public SyntheticsTestOptions followRedirects(Boolean followRedirects)

    • getFollowRedirects

      @Nullable public Boolean getFollowRedirects()
      For API HTTP test, whether or not the test should follow redirects.
      Returns:
      followRedirects

    • setFollowRedirects

      public void setFollowRedirects(Boolean followRedirects)

    • httpVersion

      public SyntheticsTestOptions httpVersion(SyntheticsTestOptionsHTTPVersion httpVersion)

    • getHttpVersion

      @Nullable public SyntheticsTestOptionsHTTPVersion getHttpVersion()
      HTTP version to use for a Synthetic test.
      Returns:
      httpVersion

    • setHttpVersion

      public void setHttpVersion(SyntheticsTestOptionsHTTPVersion httpVersion)

    • ignoreServerCertificateError

      public SyntheticsTestOptions ignoreServerCertificateError(Boolean ignoreServerCertificateError)

    • getIgnoreServerCertificateError

      @Nullable public Boolean getIgnoreServerCertificateError()
      Ignore server certificate error for browser tests.
      Returns:
      ignoreServerCertificateError

    • setIgnoreServerCertificateError

      public void setIgnoreServerCertificateError(Boolean ignoreServerCertificateError)

    • ignoreCertificateValidation

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

    • initialNavigationTimeout

      public SyntheticsTestOptions initialNavigationTimeout(Long initialNavigationTimeout)

    • getInitialNavigationTimeout

      @Nullable public Long getInitialNavigationTimeout()
      Timeout before declaring the initial step as failed (in seconds) for browser tests.
      Returns:
      initialNavigationTimeout

    • setInitialNavigationTimeout

      public void setInitialNavigationTimeout(Long initialNavigationTimeout)

    • minFailureDuration

      public SyntheticsTestOptions minFailureDuration(Long minFailureDuration)

    • getMinFailureDuration

      @Nullable public Long getMinFailureDuration()
      Minimum amount of time in failure required to trigger an alert.
      Returns:
      minFailureDuration

    • setMinFailureDuration

      public void setMinFailureDuration(Long minFailureDuration)

    • minLocationFailed

      public SyntheticsTestOptions minLocationFailed(Long minLocationFailed)

    • getMinLocationFailed

      @Nullable public Long getMinLocationFailed()
      Minimum number of locations in failure required to trigger an alert.
      Returns:
      minLocationFailed

    • setMinLocationFailed

      public void setMinLocationFailed(Long minLocationFailed)

    • monitorName

      public SyntheticsTestOptions monitorName(String monitorName)

    • getMonitorName

      @Nullable public String getMonitorName()
      The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
      Returns:
      monitorName

    • setMonitorName

      public void setMonitorName(String monitorName)

    • monitorOptions

      public SyntheticsTestOptions monitorOptions(SyntheticsTestOptionsMonitorOptions monitorOptions)

    • getMonitorOptions

      @Nullable public SyntheticsTestOptionsMonitorOptions getMonitorOptions()
      Object containing the options for a Synthetic test as a monitor (for example, renotification).
      Returns:
      monitorOptions

    • setMonitorOptions

      public void setMonitorOptions(SyntheticsTestOptionsMonitorOptions monitorOptions)

    • monitorPriority

      public SyntheticsTestOptions monitorPriority(Integer monitorPriority)

    • getMonitorPriority

      @Nullable public Integer getMonitorPriority()
      Integer from 1 (high) to 5 (low) indicating alert severity. minimum: 1 maximum: 5
      Returns:
      monitorPriority

    • setMonitorPriority

      public void setMonitorPriority(Integer monitorPriority)

    • noScreenshot

      public SyntheticsTestOptions noScreenshot(Boolean noScreenshot)

    • getNoScreenshot

      @Nullable public Boolean getNoScreenshot()
      Prevents saving screenshots of the steps.
      Returns:
      noScreenshot

    • setNoScreenshot

      public void setNoScreenshot(Boolean noScreenshot)

    • restrictedRoles

      public SyntheticsTestOptions restrictedRoles(List<String> restrictedRoles)

    • addRestrictedRolesItem

      public SyntheticsTestOptions addRestrictedRolesItem(String restrictedRolesItem)

    • getRestrictedRoles

      @Deprecated @Nullable public List<String> getRestrictedRoles()
      Deprecated.
      A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions.
      Returns:
      restrictedRoles

    • setRestrictedRoles

      @Deprecated public void setRestrictedRoles(List<String> restrictedRoles)
      Deprecated.

    • retry

      public SyntheticsTestOptions retry(SyntheticsTestOptionsRetry retry)

    • getRetry

      @Nullable public SyntheticsTestOptionsRetry getRetry()
      Object describing the retry strategy to apply to a Synthetic test.
      Returns:
      retry

    • setRetry

      public void setRetry(SyntheticsTestOptionsRetry retry)

    • rumSettings

      public SyntheticsTestOptions rumSettings(SyntheticsBrowserTestRumSettings rumSettings)

    • getRumSettings

      @Nullable public SyntheticsBrowserTestRumSettings getRumSettings()
      The RUM data collection settings for the Synthetic browser test. Note: There are 3 ways to format RUM settings:

      { isEnabled: false } RUM data is not collected.

      { isEnabled: true } RUM data is collected from the Synthetic test's default application.

      { isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 } RUM data is collected using the specified application.

      Returns:
      rumSettings

    • setRumSettings

      public void setRumSettings(SyntheticsBrowserTestRumSettings rumSettings)

    • scheduling

      public SyntheticsTestOptions scheduling(SyntheticsTestOptionsScheduling scheduling)

    • getScheduling

      @Nullable public SyntheticsTestOptionsScheduling getScheduling()
      Object containing timeframes and timezone used for advanced scheduling.
      Returns:
      scheduling

    • setScheduling

      public void setScheduling(SyntheticsTestOptionsScheduling scheduling)

    • tickEvery

      public SyntheticsTestOptions tickEvery(Long tickEvery)

    • getTickEvery

      @Nullable public Long getTickEvery()
      The frequency at which to run the Synthetic test (in seconds). minimum: 30 maximum: 604800
      Returns:
      tickEvery

    • setTickEvery

      public void setTickEvery(Long tickEvery)

    • putAdditionalProperty

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

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