Package com.nettoolkit.dashboards

Class StartDurationRequest

java.lang.Object

com.nettoolkit.internal.request.BaseApiRequest

com.nettoolkit.internal.request.PostRequest

com.nettoolkit.dashboards.StartDurationRequest

public class StartDurationRequest
extends PostRequest

Constructor Summary

Constructors

Constructor	Description
StartDurationRequest(DashboardsClient client)

Method Summary

Modifier and Type	Method	Description
StartDurationRequest	additionalValues(JSONObject jsonAdditionalValues)	Sets the duration start additional values JSON.
StartDurationRequest	additionalValues(String strAdditionalValuesJson)	Sets the duration start additional values JSON string.
StartDurationRequest	channelId(UUID channelId)	Sets the channel for this duration by ID.
StartDurationRequest	channelName(String strChannelName)	Sets the channel for this duration by name.
protected HttpContentType	getContentType()
protected String	getPath()
Duration	send()	Sends the request.
StartDurationRequest	timestamp(OffsetDateTime timestamp)	Sets the duration start time.

Methods inherited from class com.nettoolkit.internal.request.PostRequest

getHttpMethod, newHttpRequestBuilder, serializeParameters

Methods inherited from class com.nettoolkit.internal.request.BaseApiRequest

getClient, getParameters, toHttpRequest, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

StartDurationRequest

public StartDurationRequest(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 StartDurationRequest channelName(String strChannelName)

Sets the channel for this duration by name. required unless channel ID is given

Parameters:

strChannelName - the channel name

Returns:

this

channelId

public StartDurationRequest channelId(UUID channelId)

Sets the channel for this duration by ID. required unless channel name is given

Parameters:

channelId - the channel ID

Returns:

this

timestamp

public StartDurationRequest timestamp(OffsetDateTime timestamp)

Sets the duration start time. By default, uses current time.

Parameters:

timestamp - the start time

Returns:

this

additionalValues

public StartDurationRequest additionalValues(JSONObject jsonAdditionalValues)

Sets the duration start additional values JSON.

Parameters:

jsonAdditionalValues - the additional values JSON

Returns:

this

additionalValues

public StartDurationRequest additionalValues(String strAdditionalValuesJson)

Sets the duration start 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:

a duration object

Throws:

NetToolKitException