Package com.datadog.api.client.v2.model

Class SyntheticsTestOptions

java.lang.Object
com.datadog.api.client.v2.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

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

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

    • 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