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

Class SyntheticsStep

java.lang.Object
com.datadog.api.client.v1.model.SyntheticsStep
@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator") public class SyntheticsStep extends Object
The steps used in a Synthetic browser test.

  • Field Details

  • Constructor Details

    • SyntheticsStep

      public SyntheticsStep()

  • Method Details

    • allowFailure

      public SyntheticsStep allowFailure(Boolean allowFailure)

    • getAllowFailure

      @Nullable public Boolean getAllowFailure()
      A boolean set to allow this step to fail.
      Returns:
      allowFailure

    • setAllowFailure

      public void setAllowFailure(Boolean allowFailure)

    • alwaysExecute

      public SyntheticsStep alwaysExecute(Boolean alwaysExecute)

    • getAlwaysExecute

      @Nullable public Boolean getAlwaysExecute()
      A boolean set to always execute this step even if the previous step failed or was skipped.
      Returns:
      alwaysExecute

    • setAlwaysExecute

      public void setAlwaysExecute(Boolean alwaysExecute)

    • exitIfSucceed

      public SyntheticsStep exitIfSucceed(Boolean exitIfSucceed)

    • getExitIfSucceed

      @Nullable public Boolean getExitIfSucceed()
      A boolean set to exit the test if the step succeeds.
      Returns:
      exitIfSucceed

    • setExitIfSucceed

      public void setExitIfSucceed(Boolean exitIfSucceed)

    • isCritical

      public SyntheticsStep isCritical(Boolean isCritical)

    • getIsCritical

      @Nullable public Boolean getIsCritical()
      A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
      Returns:
      isCritical

    • setIsCritical

      public void setIsCritical(Boolean isCritical)

    • name

      public SyntheticsStep name(String name)

    • getName

      @Nullable public String getName()
      The name of the step.
      Returns:
      name

    • setName

      public void setName(String name)

    • noScreenshot

      public SyntheticsStep noScreenshot(Boolean noScreenshot)

    • getNoScreenshot

      @Nullable public Boolean getNoScreenshot()
      A boolean set to skip taking a screenshot for the step.
      Returns:
      noScreenshot

    • setNoScreenshot

      public void setNoScreenshot(Boolean noScreenshot)

    • params

      public SyntheticsStep params(Object params)

    • getParams

      @Nullable public Object getParams()
      The parameters of the step.
      Returns:
      params

    • setParams

      public void setParams(Object params)

    • publicId

      public SyntheticsStep publicId(String publicId)

    • getPublicId

      @Nullable public String getPublicId()
      The public ID of the step.
      Returns:
      publicId

    • setPublicId

      public void setPublicId(String publicId)

    • timeout

      public SyntheticsStep timeout(Long timeout)

    • getTimeout

      @Nullable public Long getTimeout()
      The time before declaring a step failed.
      Returns:
      timeout

    • setTimeout

      public void setTimeout(Long timeout)

    • type

      public SyntheticsStep type(SyntheticsStepType type)

    • getType

      @Nullable public SyntheticsStepType getType()
      Step type used in your Synthetic test.
      Returns:
      type

    • setType

      public void setType(SyntheticsStepType type)

    • putAdditionalProperty

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

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