Package com.nettoolkit.dashboards

Class CreateMilestoneRequest

java.lang.Object
com.nettoolkit.internal.request.BaseApiRequest
com.nettoolkit.internal.request.PostRequest
com.nettoolkit.dashboards.CreateMilestoneRequest
public class CreateMilestoneRequest extends PostRequest

  • Constructor Details

    • CreateMilestoneRequest

      public CreateMilestoneRequest(DashboardsClient client)

  • Method Details

    • getContentType

      protected HttpContentType getContentType()
      Specified by:
      getContentType in class PostRequest

    • getPath

      protected String getPath()
      Specified by:
      getPath in class BaseApiRequest

    • durationId

      public CreateMilestoneRequest durationId(UUID durationId)
      Sets the duration for this milestone. required unless channel ID/name provided
      Parameters:
      durationId - the duration ID
      Returns:
      this

    • channelName

      public CreateMilestoneRequest channelName(String strChannelName)
      Sets the duration for this milestone by channel name.
      Parameters:
      strChannelName - the channel name
      Returns:
      this

    • channelId

      public CreateMilestoneRequest channelId(UUID channelId)
      Sets the duration for this milestone by channel ID.
      Parameters:
      channelId - the channel ID
      Returns:
      this

    • name

      public CreateMilestoneRequest name(String strName)
      Sets the milestone name. requires
      Parameters:
      strName - the milestone name
      Returns:
      this

    • timestamp

      public CreateMilestoneRequest timestamp(OffsetDateTime timestamp)
      Sets the milestone time. By default, uses current time.
      Parameters:
      timestamp - the milestone time
      Returns:
      this

    • failure

      public CreateMilestoneRequest failure(boolean bIsFailure)
      Sets the milestone failure status. If true, this indicates that the previous time segment ended in failure.
      Parameters:
      bIsFailure - the failure status
      Returns:
      this

    • additionalValues

      public CreateMilestoneRequest additionalValues(JSONObject jsonAdditionalValues)
      Sets the milestone additional values JSON.
      Parameters:
      jsonAdditionalValues - the additional values JSON
      Returns:
      this

    • additionalValues

      public CreateMilestoneRequest additionalValues(String strAdditionalValuesJson)
      Sets the milestone additional values JSON string. This is an escape hatch for situations where it's inconvenient to use the provided JSONObject. If you use this function, you must ensure that the given string represents a valid JSON object.
      Parameters:
      strAdditionalValuesJson - the additional values JSON string
      Returns:
      this

    • send

      public Duration send() throws NetToolKitException
      Sends the request.
      Returns:
      the duration this milestone was added to
      Throws:
      NetToolKitException