net.sparkworks.cargo.client

Interface DataClient

All Known Implementing Classes:

DataClientImpl

public interface DataClient

Method Summary

Modifier and Type	Method and Description
net.sparkworks.cargo.common.dto.data.SummaryDTO	getLatestSummary(UUID resourceUuid) Retrieve latest summary values of a Resource Retrieve a summary of the data for a specific Resource by its resource ID.
net.sparkworks.cargo.common.dto.data.LatestDTO	getLatestValues(UUID resourceUuid) Retrieve latest values of a Resource Retrieve the latest aggregated values for a specific Resource by its resource ID The response contains the latest aggregated values for intervals of 5 minutes, 1 hour, 1 day and 1 month.
net.sparkworks.cargo.common.dto.data.PublishDataListDTO	publishData(net.sparkworks.cargo.common.dto.data.PublishDataListDTO publishDataListDTO) Publish data to the provided Resource.
net.sparkworks.cargo.common.dto.data.QueryLatestResourceDataResultDTO	queryLatestResourcesData(net.sparkworks.cargo.common.dto.data.QueryLatestResourceDataDTO queryLatestResourceDataDTO) Retrieve latest values of criteria matching Resources Query the latest aggregated values for multiple Resources.
net.sparkworks.cargo.common.dto.data.QueryTimeRangeResourceDataResultDTO	queryTimeRangeResourcesData(net.sparkworks.cargo.common.dto.data.QueryTimeRangeResourceDataDTO queryTimeRangeResourceDataDTO) Retrieve latest values of criteria matching Resources within a requested time window Query the aggregated historical values for multiple Resources within a requested time window.

Method Detail

getLatestSummary

net.sparkworks.cargo.common.dto.data.SummaryDTO getLatestSummary(UUID resourceUuid)

Retrieve latest summary values of a Resource Retrieve a summary of the data for a specific Resource by its resource ID. The summary contains the 42 latest aggregated values for intervals of 5 minutes, 1 hour, 1 day and 1 month. A Spark Works Accounts authenticated common user is able to query Resources that has permissions on. An administrator is able to query any Resource of the Platform

Parameters:

resourceUuid - the Resource UUID

Returns:

SummaryDTO containing the latest summary values

getLatestValues

net.sparkworks.cargo.common.dto.data.LatestDTO getLatestValues(UUID resourceUuid)

Retrieve latest values of a Resource Retrieve the latest aggregated values for a specific Resource by its resource ID The response contains the latest aggregated values for intervals of 5 minutes, 1 hour, 1 day and 1 month. A Spark Works Accounts authenticated common user is able to query Resources that has permissions on. An administrator is able to query any Resource of the Platform

Parameters:

resourceUuid - the Resource UUID

Returns:

LatestDTO containing latest values

queryLatestResourcesData

net.sparkworks.cargo.common.dto.data.QueryLatestResourceDataResultDTO queryLatestResourcesData(net.sparkworks.cargo.common.dto.data.QueryLatestResourceDataDTO queryLatestResourceDataDTO)

Retrieve latest values of criteria matching Resources Query the latest aggregated values for multiple Resources. The values can be converted to a requested unit of measurement. The response contains the latest aggregated values for intervals of 5 minutes, 1 hour, 1 day and 1 month. A Spark Works Accounts authenticated common user is able to query Resources that has permissions on. An administrator is able to query any Resource of the Platform

Parameters:

queryLatestResourceDataDTO - contains a list of query criteria QueryResourceDataCriteriaDTO

Returns:

QueryLatestResourceDataResultDTO that contains a Map that holds the requested data response for each query criteria

queryTimeRangeResourcesData

net.sparkworks.cargo.common.dto.data.QueryTimeRangeResourceDataResultDTO queryTimeRangeResourcesData(net.sparkworks.cargo.common.dto.data.QueryTimeRangeResourceDataDTO queryTimeRangeResourceDataDTO)

Retrieve latest values of criteria matching Resources within a requested time window Query the aggregated historical values for multiple Resources within a requested time window. The values can be retrieved in intervals of 5minutes, 1 hour, 1 day, 1 month and can be converted to a requested unit of measurement. A Spark Works Accounts authenticated common user is able to query Resources that has permissions on. An administrator is able to query any Resource of the Platform

Parameters:

queryTimeRangeResourceDataDTO - cointains a list of query criteria for time range requests

Returns:

QueryTimeRangeResourceDataResultDTO that contains a Map that holds the requested data response for each query criteria

publishData

net.sparkworks.cargo.common.dto.data.PublishDataListDTO publishData(net.sparkworks.cargo.common.dto.data.PublishDataListDTO publishDataListDTO)

Publish data to the provided Resource.

Parameters:

publishDataListDTO - PublishDataListDTO that holds the info of the resources and the data to publish on these resource

Returns:

PublishDataListDTO the list of the published data