com.aquaticinformatics.aquarius.sdk.timeseries.servicemodels

Class Publish.TimeSeriesDataCorrectedServiceRequest

java.lang.Object

com.aquaticinformatics.aquarius.sdk.timeseries.servicemodels.Publish.TimeSeriesDataCorrectedServiceRequest

All Implemented Interfaces:

net.servicestack.client.IReturn<Publish.TimeSeriesDataServiceResponse>

Enclosing class:

Publish

public static class Publish.TimeSeriesDataCorrectedServiceRequest
extends Object
implements net.servicestack.client.IReturn<Publish.TimeSeriesDataServiceResponse>

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	ApplyRounding True if data values should have rounding rules applied
String	GetParts The level of time series detail to report.
Boolean	IncludeGapMarkers True if the point results should include gap markers
java.time.Instant	QueryFrom Filter results to items at or after the QueryFrom time
java.time.Instant	QueryTo Filter results to items at or before the QueryTo time
Boolean	ReturnFullCoverage Defaults to false.
String	TimeSeriesUniqueId The unique ID of the time series
String	Unit The unit identifier for points.
Double	UtcOffset Forces the response time values to a specific UTC offset.

Constructor Summary

Constructors

Constructor and Description
TimeSeriesDataCorrectedServiceRequest()

Method Summary

Modifier and Type	Method and Description
String	getGetParts()
java.time.Instant	getQueryFrom()
java.time.Instant	getQueryTo()
Object	getResponseType()
String	getTimeSeriesUniqueId()
String	getUnit()
Double	getUtcOffset()
Boolean	isApplyRounding()
Boolean	isIncludeGapMarkers()
Boolean	isReturnFullCoverage()
Publish.TimeSeriesDataCorrectedServiceRequest	setApplyRounding(Boolean value)
Publish.TimeSeriesDataCorrectedServiceRequest	setGetParts(String value)
Publish.TimeSeriesDataCorrectedServiceRequest	setIncludeGapMarkers(Boolean value)
Publish.TimeSeriesDataCorrectedServiceRequest	setQueryFrom(java.time.Instant value)
Publish.TimeSeriesDataCorrectedServiceRequest	setQueryTo(java.time.Instant value)
Publish.TimeSeriesDataCorrectedServiceRequest	setReturnFullCoverage(Boolean value)
Publish.TimeSeriesDataCorrectedServiceRequest	setTimeSeriesUniqueId(String value)
Publish.TimeSeriesDataCorrectedServiceRequest	setUnit(String value)
Publish.TimeSeriesDataCorrectedServiceRequest	setUtcOffset(Double value)

Methods inherited from class java.lang.Object

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

Field Detail

TimeSeriesUniqueId

public String TimeSeriesUniqueId

The unique ID of the time series

QueryFrom

public java.time.Instant QueryFrom

Filter results to items at or after the QueryFrom time

QueryTo

public java.time.Instant QueryTo

Filter results to items at or before the QueryTo time

GetParts

public String GetParts

The level of time series detail to report. One of 'All', 'PointsOnly', or 'MetadataOnly'. Defaults to 'All'

Unit

public String Unit

The unit identifier for points. Defaults to the time series unit

UtcOffset

public Double UtcOffset

Forces the response time values to a specific UTC offset. Defaults to the time series UTC offset

ApplyRounding

public Boolean ApplyRounding

True if data values should have rounding rules applied

ReturnFullCoverage

public Boolean ReturnFullCoverage

Defaults to false. See the API reference guide for details

IncludeGapMarkers

public Boolean IncludeGapMarkers

True if the point results should include gap markers

Constructor Detail

TimeSeriesDataCorrectedServiceRequest

public TimeSeriesDataCorrectedServiceRequest()

Method Detail

getTimeSeriesUniqueId

public String getTimeSeriesUniqueId()

setTimeSeriesUniqueId

public Publish.TimeSeriesDataCorrectedServiceRequest setTimeSeriesUniqueId(String value)

getQueryFrom

public java.time.Instant getQueryFrom()

setQueryFrom

public Publish.TimeSeriesDataCorrectedServiceRequest setQueryFrom(java.time.Instant value)

getQueryTo

public java.time.Instant getQueryTo()

setQueryTo

public Publish.TimeSeriesDataCorrectedServiceRequest setQueryTo(java.time.Instant value)

getGetParts

public String getGetParts()

setGetParts

public Publish.TimeSeriesDataCorrectedServiceRequest setGetParts(String value)

getUnit

public String getUnit()

setUnit

public Publish.TimeSeriesDataCorrectedServiceRequest setUnit(String value)

getUtcOffset

public Double getUtcOffset()

setUtcOffset

public Publish.TimeSeriesDataCorrectedServiceRequest setUtcOffset(Double value)

isApplyRounding

public Boolean isApplyRounding()

setApplyRounding

public Publish.TimeSeriesDataCorrectedServiceRequest setApplyRounding(Boolean value)

isReturnFullCoverage

public Boolean isReturnFullCoverage()

setReturnFullCoverage

public Publish.TimeSeriesDataCorrectedServiceRequest setReturnFullCoverage(Boolean value)

isIncludeGapMarkers

public Boolean isIncludeGapMarkers()

setIncludeGapMarkers

public Publish.TimeSeriesDataCorrectedServiceRequest setIncludeGapMarkers(Boolean value)

getResponseType

public Object getResponseType()

Specified by:

getResponseType in interface net.servicestack.client.IReturn<Publish.TimeSeriesDataServiceResponse>