Package com.nettoolkit.dashboards

Class CreateChannelDatumRequest

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

  • Constructor Details

    • CreateChannelDatumRequest

      public CreateChannelDatumRequest(DashboardsClient client)

  • Method Details

    • getContentType

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

    • getPath

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

    • channelName

      public CreateChannelDatumRequest channelName(String strChannelName)
      Sets the channel for this datum by name. required unless channel ID is given
      Parameters:
      strChannelName - the channel name
      Returns:
      this

    • channelId

      public CreateChannelDatumRequest channelId(UUID channelId)
      Sets the channel for this datum by ID. required unless channel name is given
      Parameters:
      channelId - the channel ID
      Returns:
      this

    • value

      public CreateChannelDatumRequest value(Double dValue)
      Sets the datum value.
      Parameters:
      dValue - the numeric value
      Returns:
      this

    • additionalValues

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

    • additionalValues

      public CreateChannelDatumRequest additionalValues(String strAdditionalValuesJson)
      Sets the datum 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

    • textBlob

      public CreateChannelDatumRequest textBlob(String strTextBlob)
      Sets the datum text blob. This can be useful for sending arbitrary text data.
      Parameters:
      strTextBlob - the text blob
      Returns:
      this

    • stackTrace

      public CreateChannelDatumRequest stackTrace(Throwable throwable)
      Sets the datum text blob to a stack trace.
      Parameters:
      throwable - a throwable containing the stack trace to save
      Returns:
      this

    • send

      public ChannelDatum send() throws NetToolKitException
      Sends the request.
      Returns:
      a channel datum object
      Throws:
      NetToolKitException