dataPARC.DataSeries.SDK.DataSeriesClient Class Reference

Provides methods for reading data. More...

Public Member Functions
	DataSeriesClient (string host, int port, ICertificateValidation? certificateValidation=null, IAuthProvider? authProvider=null)
	Initializes a new instance of the ReadClient class with a hostname and port number.
async IAsyncEnumerable< BulkExportResult >	ExportRawWithInterpolationBulk (BulkExportWithInterpolationParameters parameters, [EnumeratorCancellation] CancellationToken cancellationToken=default)
	Stream exporting datapoints with to a stepsize interpolation for a collection of tags.
async IAsyncEnumerable< BulkExportResult >	ExportRawWithoutInterpolationBulk (BulkExportWithoutInterpolationParameters parameters, [EnumeratorCancellation] CancellationToken cancellationToken=default)
	Stream raw datapoints without interpolation for a collection of tags.
async Task< QuickStatisticsResult[]>	GetLatestQuickStatistics (LatestQuickStatisticsParameters parameters, CancellationToken cancellationToken=default)
	Read latest quick statistics for a collection of tags.
async Task< QuickStatisticsResult[]>	GetQuickStatistics (QuickStatisticsParameters parameters, CancellationToken cancellationToken=default)
	Read quick statistics for a collection of tags.
async Task< ReadRawResult[]>	ReadAtTimeBulk (ReadAtTimeParameters[] parameters, CancellationToken cancellationToken=default)
	Get tag datapoint for given timestamp for a collection of tags.
async Task< TagCurrentValue[]>	ReadCurrentValues (ReadCurrentValueParameters[] parameters, CancellationToken cancellationToken=default)
	Read current values for a collection of tags.
async IAsyncEnumerable< BulkAggExportResult >	ReadDataByAggregateBulk (BulkExportWithInterpolationParameters parameters, [EnumeratorCancellation] CancellationToken cancellationToken=default)
	Stream reading datapoints by aggregate type for a collection of tags.
async Task< ReadRawResult >	ReadRaw (ReadRawParameters parameters, CancellationToken cancellationToken=default)
	Read raw datapoints for a single tag.
async Task< ReadRawResult[]>	ReadRawBulk (ReadRawBulkParameters parameters, CancellationToken cancellationToken=default)
	Read raw datapoints for multiple tags.
async Task< ReadRawResult[]>	ReadRawToCurrentValues (ReadRawToCurrentValueParameters[] parameters, CancellationToken cancellationToken=default)
	Read up to current values for a collection of tags from a start time.
async Task< ReadSourceInfoResult >	ReadSourceInfo (ReadSourceInfoParameters parameters, CancellationToken cancellationToken=default)
	Read source info for a single tag.
async Task< ReadSourceInfoResult[]>	ReadSourceInfoBulk (ReadSourceInfoParameters[] parameters, CancellationToken cancellationToken=default)
	Read source info for a collection of tags.
async IAsyncEnumerable< ReadRawResult >	StreamRawBulk (StreamRawBulkParameters parameters, [EnumeratorCancellation] CancellationToken cancellationToken=default)
	Stream raw datapoints for a given time period for a list of tags.

Detailed Description

Provides methods for reading data.

Constructor & Destructor Documentation

DataSeriesClient()

dataPARC.DataSeries.SDK.DataSeriesClient.DataSeriesClient	(	string	host,
		int	port,
		ICertificateValidation?	certificateValidation = null,
		IAuthProvider?	authProvider = null )

Initializes a new instance of the ReadClient class with a hostname and port number.

Parameters

host	The hostname of the server to create connections to.
port	The port number the server to create connections to.
certificateValidation	This provides methods for validating the server's certificate.
authProvider	If authentication is enabled, this is the OAuth provider for security tokens.

Member Function Documentation

ExportRawWithInterpolationBulk()

async IAsyncEnumerable< BulkExportResult > dataPARC.DataSeries.SDK.DataSeriesClient.ExportRawWithInterpolationBulk	(	BulkExportWithInterpolationParameters	parameters,
		[EnumeratorCancellation] CancellationToken	cancellationToken = default )

Stream exporting datapoints with to a stepsize interpolation for a collection of tags.

Parameters

parameters	A collecion of parameters for streaming exporting datapoints with to a stepsize interpolation.
cancellationToken	A cancellation token that can be used to cancel the operation. If unspecified, no token is attached to the request.

Returns

A task that represents the asynchronous export operation, which wraps a BulkExportResult.

ExportRawWithoutInterpolationBulk()

async IAsyncEnumerable< BulkExportResult > dataPARC.DataSeries.SDK.DataSeriesClient.ExportRawWithoutInterpolationBulk	(	BulkExportWithoutInterpolationParameters	parameters,
		[EnumeratorCancellation] CancellationToken	cancellationToken = default )

Stream raw datapoints without interpolation for a collection of tags.

Parameters

parameters	A collecion of parameters for streaming raw datapoints without interpolation
cancellationToken	A cancellation token that can be used to cancel the operation. If unspecified, no token is attached to the request.

Returns

A task that represents the asynchronous export operation, which wraps a BulkExportResult.

GetLatestQuickStatistics()

async Task< QuickStatisticsResult[]> dataPARC.DataSeries.SDK.DataSeriesClient.GetLatestQuickStatistics	(	LatestQuickStatisticsParameters	parameters,
		CancellationToken	cancellationToken = default )

Read latest quick statistics for a collection of tags.

Parameters

parameters	A collecion of parameters for reading latest quick statistics.
cancellationToken	A cancellation token that can be used to cancel the operation. If unspecified, no token is attached to the request.

Returns

A task that represents the asynchronous read operation, which wraps a List<T> where T is QuickStatisticsResult.

GetQuickStatistics()

async Task< QuickStatisticsResult[]> dataPARC.DataSeries.SDK.DataSeriesClient.GetQuickStatistics	(	QuickStatisticsParameters	parameters,
		CancellationToken	cancellationToken = default )

Read quick statistics for a collection of tags.

Parameters

parameters	A collecion of parameters for reading quick statistics.
cancellationToken	A cancellation token that can be used to cancel the operation. If unspecified, no token is attached to the request.

Returns

A task that represents the asynchronous read operation, which wraps a List<T> where T is QuickStatisticsResult.

ReadAtTimeBulk()

async Task< ReadRawResult[]> dataPARC.DataSeries.SDK.DataSeriesClient.ReadAtTimeBulk	(	ReadAtTimeParameters[]	parameters,
		CancellationToken	cancellationToken = default )

Get tag datapoint for given timestamp for a collection of tags.

Parameters

parameters	A collecion of parameters for streaming raw datapoints.
cancellationToken	A cancellation token that can be used to cancel the operation. If unspecified, no token is attached to the request.

Returns

A task that represents the asynchronous read operation, which wraps a List<T> where T is ReadRawResult.

ReadCurrentValues()

async Task< TagCurrentValue[]> dataPARC.DataSeries.SDK.DataSeriesClient.ReadCurrentValues	(	ReadCurrentValueParameters[]	parameters,
		CancellationToken	cancellationToken = default )

Read current values for a collection of tags.

Parameters

parameters	A collecion of parameters for reading current values.
cancellationToken	A cancellation token that can be used to cancel the operation. If unspecified, no token is attached to the request.

Returns

A task that represents the asynchronous read operation, which wraps a List<T> where T is TagCurrentValue.

ReadDataByAggregateBulk()

async IAsyncEnumerable< BulkAggExportResult > dataPARC.DataSeries.SDK.DataSeriesClient.ReadDataByAggregateBulk	(	BulkExportWithInterpolationParameters	parameters,
		[EnumeratorCancellation] CancellationToken	cancellationToken = default )

Stream reading datapoints by aggregate type for a collection of tags.

Parameters

parameters	A collecion of parameters for streaming datapoints by aggregate type.
cancellationToken	A cancellation token that can be used to cancel the operation. If unspecified, no token is attached to the request.

Returns

A task that represents the asynchronous read operation, which wraps a BulkAggExportResult.

ReadRaw()

async Task< ReadRawResult > dataPARC.DataSeries.SDK.DataSeriesClient.ReadRaw	(	ReadRawParameters	parameters,
		CancellationToken	cancellationToken = default )

Read raw datapoints for a single tag.

Parameters

parameters	A collecion of parameters for reading raw datapoints.
cancellationToken	A cancellation token that can be used to cancel the operation. If unspecified, no token is attached to the request.

Returns

A task that represents the asynchronous read operation, which wraps a List<T> where T is ReadRawResult.

ReadRawBulk()

async Task< ReadRawResult[]> dataPARC.DataSeries.SDK.DataSeriesClient.ReadRawBulk	(	ReadRawBulkParameters	parameters,
		CancellationToken	cancellationToken = default )

Read raw datapoints for multiple tags.

Parameters

parameters	A collecion of parameters for reading raw datapoints.
cancellationToken	A cancellation token that can be used to cancel the operation. If unspecified, no token is attached to the request.

Returns

A task that represents the asynchronous read operation, which wraps a List<T> where T is ReadRawResult.

ReadRawToCurrentValues()

async Task< ReadRawResult[]> dataPARC.DataSeries.SDK.DataSeriesClient.ReadRawToCurrentValues	(	ReadRawToCurrentValueParameters[]	parameters,
		CancellationToken	cancellationToken = default )

Read up to current values for a collection of tags from a start time.

Parameters

parameters	A collecion of parameters for reading up to current values.
cancellationToken	A cancellation token that can be used to cancel the operation. If unspecified, no token is attached to the request.

Returns

A task that represents the asynchronous read operation, which wraps a List<T> where T is ReadRawResult.

ReadSourceInfo()

async Task< ReadSourceInfoResult > dataPARC.DataSeries.SDK.DataSeriesClient.ReadSourceInfo	(	ReadSourceInfoParameters	parameters,
		CancellationToken	cancellationToken = default )

Read source info for a single tag.

Parameters

parameters	A collecion of parameters for reading source info.
cancellationToken	A cancellation token that can be used to cancel the operation. If unspecified, no token is attached to the request.

Returns

A task that represents the asynchronous read operation, which wraps a ReadSourceInfoResult.

ReadSourceInfoBulk()

async Task< ReadSourceInfoResult[]> dataPARC.DataSeries.SDK.DataSeriesClient.ReadSourceInfoBulk	(	ReadSourceInfoParameters[]	parameters,
		CancellationToken	cancellationToken = default )

Read source info for a collection of tags.

Parameters

parameters	A collecion of parameters for reading source info for a collection of tags.
cancellationToken	A cancellation token that can be used to cancel the operation. If unspecified, no token is attached to the request.

Returns

A task that represents the asynchronous read operation, which wraps a List<T> where T is ReadSourceInfoResult.

StreamRawBulk()

async IAsyncEnumerable< ReadRawResult > dataPARC.DataSeries.SDK.DataSeriesClient.StreamRawBulk	(	StreamRawBulkParameters	parameters,
		[EnumeratorCancellation] CancellationToken	cancellationToken = default )

Stream raw datapoints for a given time period for a list of tags.

Parameters

parameters	A collecion of parameters for streaming raw datapoints.
cancellationToken	A cancellation token that can be used to cancel the operation. If unspecified, no token is attached to the request.

Returns

A task that represents the asynchronous read operation, which wraps a List<T> where T is ReadRawResult.