ITimeSeriesStore Interface
The time series store used to load, save, delete, and find time series. Should only be instantiated by an ITimeSeriesStoreFactory.
public interface ITimeSeriesStore : HAKOM.Persistence.Core.Net.Api.Storage.IStore<HAKOM.Persistence.Core.Net.Api.Storage.IStorageProvider>Derived
↳ ITimeSeriesStore<TIdentifier>
↳ ISqlTimeSeriesStore
Implements HAKOM.Persistence.Core.Net.Api.Storage.IStore<IStorageProvider>
Properties
Section titled “Properties”ITimeSeriesStore.SearchParameters Property
Section titled “ITimeSeriesStore.SearchParameters Property”Gets the ITimeSeriesSearchParametersFactory associated with this store.
HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesSearchParametersFactory SearchParameters { get; }Property Value
Section titled “Property Value”ITimeSeriesSearchParametersFactory
Remarks
Section titled “Remarks”This should be used in order to create search parameters for use with the Find/TryFind methods.
var tsm = ITsm.Create();var repository = await tsm.Repositories.Load("My repository");var timeSeriesStore = await repository.GetTimeSeriesStore();var results = timeSeriesStore.Find( timeSeriesStore.SearchParameters.Create( name: "*", description: "time series number ?" ));await foreach (ITimeSeriesReference result in results) { ITimeSeries timeSeries = await result.Resolve(); Console.WriteLine(timeSeries.Name);}Methods
Section titled “Methods”ITimeSeriesStore.Configure(IStorageProvider, IUnitStore, CancellationToken) Method
Section titled “ITimeSeriesStore.Configure(IStorageProvider, IUnitStore, CancellationToken) Method”Configures the time series store with the given parameters.
System.Threading.Tasks.Task Configure(HAKOM.Persistence.Core.Net.Api.Storage.IStorageProvider storageProvider, HAKOM.TSM.Net.Api.Units.Persistence.IUnitStore unitStore, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”storageProvider IStorageProvider
The IStorageProvider used for read and write operations on the storage.
unitStore IUnitStore
The IUnitStore used for creating unit references.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task that completes when configuration is applied.
ITimeSeriesStore.Count(CancellationToken) Method
Section titled “ITimeSeriesStore.Count(CancellationToken) Method”Counts the amount of time series objects in the repository.
System.Threading.Tasks.Task<long> Count(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<System.Int64>
A System.Threading.Tasks.Task containing the amount as a System.Int64.
ITimeSeriesStore.Delete(ITimeSeriesReference, bool, CancellationToken) Method
Section titled “ITimeSeriesStore.Delete(ITimeSeriesReference, bool, CancellationToken) Method”Deletes a given timeSeriesReference from the repository.
System.Threading.Tasks.Task Delete(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, bool cascade=true, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeries object representing the time series to be deleted.
cascade System.Boolean
If set to true (default) it also deletes all data referenced to the time series.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task.
ITimeSeriesStore.Delete(string, bool, CancellationToken) Method
Section titled “ITimeSeriesStore.Delete(string, bool, CancellationToken) Method”Deletes a time series from the repository based on the given name.
System.Threading.Tasks.Task Delete(string name, bool cascade=true, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”name System.String
The System.String name of the time series to be deleted.
cascade System.Boolean
If set to true (default) it also deletes all data referenced to the time series.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task.
ITimeSeriesStore.DeleteAssignment<TAssigned>(IReference<TAssigned>, ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.DeleteAssignment<TAssigned>(IReference<TAssigned>, ITimeSeriesReference, CancellationToken) Method”Deletes an assignment from the given ITimeSeriesReference.
System.Threading.Tasks.Task DeleteAssignment<TAssigned>(HAKOM.Persistence.Core.Net.Api.References.IReference<TAssigned> assigned, HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference from, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”assigned HAKOM.Persistence.Core.Net.Api.References.IReference<TAssigned>
The IReference<TReferred> of the IAssignableToTimeSeries to delete.
from ITimeSeriesReference
The ITimeSeriesReference representing the time series to delete the assignable reference from.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task
An awaitable System.Threading.Tasks.Task representing the asynchronous operation.
ITimeSeriesStore.DeleteAssignment<TAssigned>(ITimeSeriesAssignmentReference<TAssigned>, CancellationToken) Method
Section titled “ITimeSeriesStore.DeleteAssignment<TAssigned>(ITimeSeriesAssignmentReference<TAssigned>, CancellationToken) Method”Deletes a given ITimeSeriesAssignmentReference<TAssigned>.
System.Threading.Tasks.Task DeleteAssignment<TAssigned>(HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned> timeSeriesAssignmentReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”timeSeriesAssignmentReference HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>
The reference of the time series assignment (ITimeSeriesAssignmentReference<TAssigned>) which will be reloaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task.
ITimeSeriesStore.DeleteAssignments<TAssigned>(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.DeleteAssignments<TAssigned>(ITimeSeriesReference, CancellationToken) Method”Deletes all assignments of type TAssigned from the given ITimeSeriesReference.
System.Threading.Tasks.Task DeleteAssignments<TAssigned>(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference from, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”from ITimeSeriesReference
The ITimeSeriesReference object representing the time series to delete the assignable references from.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task.
ITimeSeriesStore.DeleteListAttributeAssignments(IListAttributeUnitReference, CancellationToken) Method
Section titled “ITimeSeriesStore.DeleteListAttributeAssignments(IListAttributeUnitReference, CancellationToken) Method”Deletes all list attribute assignments where the given IListAttributeUnitReference is selected.
System.Threading.Tasks.Task DeleteListAttributeAssignments(HAKOM.TSM.Net.Api.Attributes.Lists.Persistence.References.IListAttributeUnitReference listAttributeUnitReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”listAttributeUnitReference IListAttributeUnitReference
The IListAttributeUnitReference object referring to the selected IListAttributeUnitReference.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task
An awaitable System.Threading.Tasks.Task indicating deletion completion.
ITimeSeriesStore.Find(bool, ITimeSeriesSearchParameters, Range<ITimeSeries>, IEnumerable<Order<ITimeSeries>>, CancellationToken) Method
Section titled “ITimeSeriesStore.Find(bool, ITimeSeriesSearchParameters, Range<ITimeSeries>, IEnumerable<Order<ITimeSeries>>, CancellationToken) Method”Finds time series as ITimeSeriesReference based on the given parameters, sorts them based on the given orderings and returns only a specified range from the results for pagination.
System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Find(bool includeAttributes, HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesSearchParameters? parameters=null, HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries> range=default(HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries>), System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries>>? orderings=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”includeAttributes System.Boolean
Decides if the results should contain assigned attributes and their related data.
parameters ITimeSeriesSearchParameters
The ITimeSeriesSearchParameters by which the search will be filtered.
range HAKOM.Persistence.Core.Net.Api.Paging.Range<ITimeSeries>
An optional System.Range by which the results should be limited.
orderings System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<ITimeSeries>>
A list of Order<TResult> by which the results will be ordered.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<ITimeSeriesReference>
An System.Collections.Generic.IAsyncEnumerable<> containing the found time series as ITimeSeriesReference.
Remarks
Section titled “Remarks”Removes consecutive duplicate orderings, retaining only the last specified Direction for each.
ITimeSeriesStore.Find(ITimeSeriesSearchParameters, Range<ITimeSeries>, IEnumerable<Order<ITimeSeries>>, CancellationToken) Method
Section titled “ITimeSeriesStore.Find(ITimeSeriesSearchParameters, Range<ITimeSeries>, IEnumerable<Order<ITimeSeries>>, CancellationToken) Method”Finds time series as ITimeSeriesReference based on the given parameters, sorts them based on the given orderings and returns only a specified range from the results for pagination.
System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Find(HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesSearchParameters? parameters=null, HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries> range=default(HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries>), System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries>>? orderings=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”parameters ITimeSeriesSearchParameters
The ITimeSeriesSearchParameters by which the search will be filtered.
range HAKOM.Persistence.Core.Net.Api.Paging.Range<ITimeSeries>
An optional System.Range by which the results should be limited.
orderings System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<ITimeSeries>>
A list of Order<TResult> by which the results will be ordered.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<ITimeSeriesReference>
An System.Collections.Generic.IAsyncEnumerable<> containing the found time series as ITimeSeriesReference.
Remarks
Section titled “Remarks”Removes consecutive duplicate orderings, retaining only the last specified Direction for each.
ITimeSeriesStore.Find(TimeSeriesResultContent, ITimeSeriesSearchParameters, Range<ITimeSeries>, IEnumerable<Order<ITimeSeries>>, CancellationToken) Method
Section titled “ITimeSeriesStore.Find(TimeSeriesResultContent, ITimeSeriesSearchParameters, Range<ITimeSeries>, IEnumerable<Order<ITimeSeries>>, CancellationToken) Method”Finds time series as ITimeSeriesReference based on the given parameters, sorts them based on the given orderings and returns only a specified range from the results for pagination.
System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Find(HAKOM.TSM.Net.Api.TimeSeries.Persistence.TimeSeriesResultContent content, HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesSearchParameters? parameters=null, HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries> range=default(HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries>), System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries>>? orderings=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”content TimeSeriesResultContent
Decides which data is loaded together with the time series definitions.
parameters ITimeSeriesSearchParameters
The ITimeSeriesSearchParameters by which the search will be filtered.
range HAKOM.Persistence.Core.Net.Api.Paging.Range<ITimeSeries>
An optional System.Range by which the results should be limited.
orderings System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<ITimeSeries>>
A list of Order<TResult> by which the results will be ordered.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<ITimeSeriesReference>
An System.Collections.Generic.IAsyncEnumerable<> containing the found time series as ITimeSeriesReference.
Remarks
Section titled “Remarks”Removes consecutive duplicate orderings, retaining only the last specified Direction for each.
ITimeSeriesStore.FindAssignments(IAttributeReference, IListAttributeUnitReference, CancellationToken) Method
Section titled “ITimeSeriesStore.FindAssignments(IAttributeReference, IListAttributeUnitReference, CancellationToken) Method”Get all assignments of given IAttributeReference and/or IListAttributeUnitReference to ITimeSeriesReferences.
System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<HAKOM.TSM.Net.Api.Attributes.IAttribute>> FindAssignments(HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference? attributeReference, HAKOM.TSM.Net.Api.Attributes.Lists.Persistence.References.IListAttributeUnitReference? listAttributeUnitReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”attributeReference IAttributeReference
IAttributeReference for which to find assigned ITimeSeriesReference.
listAttributeUnitReference IListAttributeUnitReference
IListAttributeUnitReference for which to find ITimeSeriesReference to IAttributeReference assignments.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<IAttribute>>
An System.Collections.Generic.IAsyncEnumerable<> of ITimeSeriesAssignmentReference<TAssigned> of IAttribute.
Remarks
Section titled “Remarks”At least one of the parameters attributeReference, listAttributeUnitReference must be specified. If both are specified, the results will contain assignments that meet both requirements.
ITimeSeriesStore.FindAssignments<TAssigned>(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.FindAssignments<TAssigned>(ITimeSeriesReference, CancellationToken) Method”Gets all assignments from the given ITimeSeriesReference.
System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>> FindAssignments<TAssigned>(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference from, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”from ITimeSeriesReference
The ITimeSeriesReference representing the time series to find the assignable references from.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>>
An System.Collections.Generic.IAsyncEnumerable<> of ITimeSeriesAssignmentReference<TAssigned>.
ITimeSeriesStore.Load(ITimeSeriesReference, TimeSeriesResultContent, CancellationToken) Method
Section titled “ITimeSeriesStore.Load(ITimeSeriesReference, TimeSeriesResultContent, CancellationToken) Method”Loads a single time series as ITimeSeriesReference from storage together with the requested content.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Load(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.TSM.Net.Api.TimeSeries.Persistence.TimeSeriesResultContent content, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The reference of the time series (ITimeSeriesReference) which will be reloaded.
content TimeSeriesResultContent
The TimeSeriesResultContent to be returned together with the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the ITimeSeriesReference object.
ITimeSeriesStore.Load(ITimeSeriesReference, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.Load(ITimeSeriesReference, DateTimeOffset, CancellationToken) Method”Loads a single time series as ITimeSeriesReference from storage in the state from a specific date and time.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Load(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The reference of the time series (ITimeSeriesReference) which will be reloaded.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the date and time of the state in which the time series is loaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the ITimeSeriesReference object.
ITimeSeriesStore.Load(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.Load(ITimeSeriesReference, CancellationToken) Method”Loads a single time series as ITimeSeriesReference from storage.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Load(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The reference of the time series (ITimeSeriesReference) which will be reloaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the ITimeSeriesReference object.
ITimeSeriesStore.Load(string, TimeSeriesResultContent, CancellationToken) Method
Section titled “ITimeSeriesStore.Load(string, TimeSeriesResultContent, CancellationToken) Method”Loads a single time series as ITimeSeriesReference from storage together with the requested content.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Load(string name, HAKOM.TSM.Net.Api.TimeSeries.Persistence.TimeSeriesResultContent content, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”name System.String
The unique name of the time series.
content TimeSeriesResultContent
The TimeSeriesResultContent to be returned together with the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the ITimeSeriesReference object.
ITimeSeriesStore.Load(string, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.Load(string, DateTimeOffset, CancellationToken) Method”Loads a single time series as ITimeSeriesReference from storage in the state from a specific date and time.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Load(string name, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”name System.String
The unique name of the time series.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the date and time of the state in which the time series is loaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the ITimeSeriesReference object.
ITimeSeriesStore.Load(string, CancellationToken) Method
Section titled “ITimeSeriesStore.Load(string, CancellationToken) Method”Loads a single time series as ITimeSeriesReference from storage.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Load(string name, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”name System.String
The unique name of the time series.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the ITimeSeriesReference object.
ITimeSeriesStore.LoadAssignment<TAssigned>(IReference<TAssigned>, ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.LoadAssignment<TAssigned>(IReference<TAssigned>, ITimeSeriesReference, CancellationToken) Method”Loads a single time series assignment as ITimeSeriesAssignmentReference<TAssigned> from storage.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>> LoadAssignment<TAssigned>(HAKOM.Persistence.Core.Net.Api.References.IReference<TAssigned> assigned, HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference to, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”assigned HAKOM.Persistence.Core.Net.Api.References.IReference<TAssigned>
The IReference<TReferred> of the IAssignableToTimeSeries to load.
The ITimeSeriesReference representing the time series to load the assignable reference from.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>>
A System.Threading.Tasks.Task containing the ITimeSeriesAssignmentReference<TAssigned> object.
ITimeSeriesStore.LoadAssignment<TAssigned>(ITimeSeriesAssignmentReference<TAssigned>, CancellationToken) Method
Section titled “ITimeSeriesStore.LoadAssignment<TAssigned>(ITimeSeriesAssignmentReference<TAssigned>, CancellationToken) Method”Loads a single time series assignment as ITimeSeriesAssignmentReference<TAssigned> from storage.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>> LoadAssignment<TAssigned>(HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned> timeSeriesAssignmentReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”timeSeriesAssignmentReference HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>
The reference of the time series assignment (ITimeSeriesAssignmentReference<TAssigned>) which will be reloaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>>
A System.Threading.Tasks.Task containing the ITimeSeriesAssignmentReference<TAssigned> object.
ITimeSeriesStore.LoadBulk(IReadOnlyCollection<string>, TimeSeriesResultContent, CancellationToken) Method
Section titled “ITimeSeriesStore.LoadBulk(IReadOnlyCollection<string>, TimeSeriesResultContent, CancellationToken) Method”Loads several time series by their names together with the requested content, yielding one reference per distinct name keyed by that name.
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.KeyValuePair<string,HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> LoadBulk(System.Collections.Generic.IReadOnlyCollection<string> names, HAKOM.TSM.Net.Api.TimeSeries.Persistence.TimeSeriesResultContent content, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”names System.Collections.Generic.IReadOnlyCollection<System.String>
The unique names of the time series.
content TimeSeriesResultContent
The TimeSeriesResultContent to be returned together with the time series definitions.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.KeyValuePair<System.String,ITimeSeriesReference>>
An System.Collections.Generic.IAsyncEnumerable<> of System.Collections.Generic.KeyValuePair<> pairing each distinct name with its
ITimeSeriesReference.
ITimeSeriesStore.Save(ITimeSeries, IStorageInformation, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.Save(ITimeSeries, IStorageInformation, DateTimeOffset, CancellationToken) Method”Tries to save a new time series with information about where its data is stored and further includes information about the exact point in time, at which the time series was in the given state.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Save(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.Save(ITimeSeries, IStorageInformation, CancellationToken) Method
Section titled “ITimeSeriesStore.Save(ITimeSeries, IStorageInformation, CancellationToken) Method”Saves a new time series with information about where its data is stored.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Save(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.Save(ITimeSeries, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.Save(ITimeSeries, DateTimeOffset, CancellationToken) Method”Saves a new time series including information about the exact point in time, at which the time series was in the given state.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Save(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
An System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.Save(ITimeSeries, CancellationToken) Method
Section titled “ITimeSeriesStore.Save(ITimeSeries, CancellationToken) Method”Saves a new time series.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Save(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.Save(ITimeSeriesReference, IStorageInformation, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.Save(ITimeSeriesReference, IStorageInformation, DateTimeOffset, CancellationToken) Method”Saves a new time series based on a reference.
Further takes information about where its data is stored.
It includes information about the exact point in time, at which the time series was in the given state.
May be used to copy a time series to another repository.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Save(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be retrieved and saved.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.Save(ITimeSeriesReference, IStorageInformation, CancellationToken) Method
Section titled “ITimeSeriesStore.Save(ITimeSeriesReference, IStorageInformation, CancellationToken) Method”Saves a new time series based on a reference.
Further takes information about where its data is stored.
May be used to copy a time series to another repository.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Save(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be retrieved and saved.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.Save(ITimeSeriesReference, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.Save(ITimeSeriesReference, DateTimeOffset, CancellationToken) Method”Saves a new time series based on a reference.
Further takes information about where its data is stored and further includes information about the exact point in time,
at which the time series was in the given state.
It includes information about the exact point in time, at which the time series was in the given state.
May be used to copy a time series to another repository.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Save(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be retrieved and saved.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.Save(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.Save(ITimeSeriesReference, CancellationToken) Method”Saves a new time series based on a reference.
May be used to copy a time series to another repository.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> Save(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be retrieved and saved.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.SaveAssignment<TAssigned>(IReference<TAssigned>, ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.SaveAssignment<TAssigned>(IReference<TAssigned>, ITimeSeriesReference, CancellationToken) Method”Saves an assignment onto the given ITimeSeriesReference.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>> SaveAssignment<TAssigned>(HAKOM.Persistence.Core.Net.Api.References.IReference<TAssigned> assigned, HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference to, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”assigned HAKOM.Persistence.Core.Net.Api.References.IReference<TAssigned>
The IReference<TReferred> of the IAssignableToTimeSeries to store.
The ITimeSeriesReference representing the time series to store the assignable reference on.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>>
A System.Threading.Tasks.Task containing the ITimeSeriesAssignmentReference<TAssigned> object.
ITimeSeriesStore.SaveBulk(IReadOnlyDictionary<int,ITimeSeries>, CancellationToken) Method
Section titled “ITimeSeriesStore.SaveBulk(IReadOnlyDictionary<int,ITimeSeries>, CancellationToken) Method”Saves multiple new time series in a single bulk operation, yielding one reference per input item tagged with that item’s caller-assigned key.
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.KeyValuePair<int,HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> SaveBulk(System.Collections.Generic.IReadOnlyDictionary<int,HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries> items, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”items System.Collections.Generic.IReadOnlyDictionary<System.Int32,ITimeSeries>
The ITimeSeries items to save, keyed by a caller-assigned correlation handle.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.KeyValuePair<System.Int32,ITimeSeriesReference>>
An System.Collections.Generic.IAsyncEnumerable<> of System.Collections.Generic.KeyValuePair<> pairing each
input key with its saved ITimeSeriesReference, one per input key.
ITimeSeriesStore.SaveOrUpdate(ITimeSeries, IStorageInformation, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.SaveOrUpdate(ITimeSeries, IStorageInformation, DateTimeOffset, CancellationToken) Method”Saves or updates the given time series.
Further takes information about where its data is stored.
It includes information about the exact point in time, at which the time series was in the given state.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> SaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved or updated.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.SaveOrUpdate(ITimeSeries, IStorageInformation, CancellationToken) Method
Section titled “ITimeSeriesStore.SaveOrUpdate(ITimeSeries, IStorageInformation, CancellationToken) Method”Saves or updates the given time series.
Further takes information about where its data is stored and further includes information about the exact point in time,
at which the time series was in the given state.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> SaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved or updated.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.SaveOrUpdate(ITimeSeries, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.SaveOrUpdate(ITimeSeries, DateTimeOffset, CancellationToken) Method”Saves or updates the given time series. Includes information about the exact point in time, at which the time series was in the given state.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> SaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved or updated.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.SaveOrUpdate(ITimeSeries, CancellationToken) Method
Section titled “ITimeSeriesStore.SaveOrUpdate(ITimeSeries, CancellationToken) Method”Saves or updates the given time series.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> SaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved or updated.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.SaveOrUpdate(ITimeSeriesReference, IStorageInformation, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.SaveOrUpdate(ITimeSeriesReference, IStorageInformation, DateTimeOffset, CancellationToken) Method”Saves or updates the given time series based on a reference.
Further takes information about where its data is stored.
It includes information about the exact point in time, at which the time series was in the given state.
May be used to copy or update a time series from another repository.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> SaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be saved or updated.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.SaveOrUpdate(ITimeSeriesReference, IStorageInformation, CancellationToken) Method
Section titled “ITimeSeriesStore.SaveOrUpdate(ITimeSeriesReference, IStorageInformation, CancellationToken) Method”Saves or updates the given time series based on a reference.
Further takes information about where its data is stored.
May be used to copy or update a time series from another repository.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> SaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be saved or updated.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.SaveOrUpdate(ITimeSeriesReference, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.SaveOrUpdate(ITimeSeriesReference, DateTimeOffset, CancellationToken) Method”Saves or updates the given time series based on a reference.
It includes information about the exact point in time, at which the time series was in the given state.
May be used to copy or update a time series from another repository.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> SaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be saved or updated.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.SaveOrUpdate(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.SaveOrUpdate(ITimeSeriesReference, CancellationToken) Method”Saves or updates the given time series based on a reference.
May be used to copy or update a time series from another repository.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> SaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be saved or updated.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeSeriesReference>
A System.Threading.Tasks.Task containing the saved ITimeSeriesReference.
ITimeSeriesStore.SaveOrUpdateListAttributeAssignment(IAttributeReference, ITimeSeriesReference, IListAttributeUnitReference, bool, CancellationToken) Method
Section titled “ITimeSeriesStore.SaveOrUpdateListAttributeAssignment(IAttributeReference, ITimeSeriesReference, IListAttributeUnitReference, bool, CancellationToken) Method”Saves or updates an assignment of an attribute of type ‘List’ onto the given ITimeSeriesReference.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<HAKOM.TSM.Net.Api.Attributes.IAttribute>> SaveOrUpdateListAttributeAssignment(HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference assigned, HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference to, HAKOM.TSM.Net.Api.Attributes.Lists.Persistence.References.IListAttributeUnitReference listAttributeUnitReference, bool force=false, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”assigned IAttributeReference
The IAttributeReference of the list attribute to assign.
The ITimeSeriesReference representing the time series to assign the attribute to.
listAttributeUnitReference IListAttributeUnitReference
The IListAttributeUnitReference representing the unit of the list attribute.
force System.Boolean
Determines whether an assignment’s unit can be changed when it has existing data. When false (default) and data exists, an error will be returned and the unit will remain unchanged. If there is no data, the unit will be updated. When true, all data assigned to the assignment will be deleted and the unit will be updated.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<IAttribute>>
An awaitable System.Threading.Tasks.Task<> containing a ITimeSeriesAssignmentReference<TAssigned>
which refers to the assigned list attribute.
ITimeSeriesStore.TryCount(CancellationToken) Method
Section titled “ITimeSeriesStore.TryCount(CancellationToken) Method”Tries to count the amount of time series objects in the repository.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<long>> TryCount(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<System.Int64>>
A System.Threading.Tasks.Task<> containing the amount as a System.Int64.
ITimeSeriesStore.TryDelete(ITimeSeriesReference, bool, CancellationToken) Method
Section titled “ITimeSeriesStore.TryDelete(ITimeSeriesReference, bool, CancellationToken) Method”Deletes a given timeSeriesReference from the repository.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDelete(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, bool cascade=true, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeries object representing the time series to be deleted.
cascade System.Boolean
If set to true (default) it also deletes all data referenced to the time series.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> of Result.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TryDelete(string, bool, CancellationToken) Method
Section titled “ITimeSeriesStore.TryDelete(string, bool, CancellationToken) Method”Deletes a time series from the repository based on the given name.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDelete(string name, bool cascade=true, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”name System.String
The System.String name of the time series to be deleted.
cascade System.Boolean
If set to true (default) it also deletes all data referenced to the time series.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> of Result.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TryDeleteAssignment<TAssigned>(IReference<TAssigned>, ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.TryDeleteAssignment<TAssigned>(IReference<TAssigned>, ITimeSeriesReference, CancellationToken) Method”Deletes an assignment from the given ITimeSeriesReference.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDeleteAssignment<TAssigned>(HAKOM.Persistence.Core.Net.Api.References.IReference<TAssigned> assigned, HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference from, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”assigned HAKOM.Persistence.Core.Net.Api.References.IReference<TAssigned>
The IReference<TReferred> of the IAssignableToTimeSeries to delete.
from ITimeSeriesReference
The ITimeSeriesReference representing the time series to delete the assignable reference from.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<>.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TryDeleteAssignment<TAssigned>(ITimeSeriesAssignmentReference<TAssigned>, CancellationToken) Method
Section titled “ITimeSeriesStore.TryDeleteAssignment<TAssigned>(ITimeSeriesAssignmentReference<TAssigned>, CancellationToken) Method”Attempts to delete a given ITimeSeriesAssignmentReference<TAssigned>.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDeleteAssignment<TAssigned>(HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned> timeSeriesAssignmentReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”timeSeriesAssignmentReference HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>
The reference of the time series assignment (ITimeSeriesAssignmentReference<TAssigned>) which will be reloaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<>.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TryDeleteAssignments<TAssigned>(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.TryDeleteAssignments<TAssigned>(ITimeSeriesReference, CancellationToken) Method”Deletes all assignments of type TAssigned from the given ITimeSeriesReference.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDeleteAssignments<TAssigned>(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference from, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”from ITimeSeriesReference
The ITimeSeriesReference object representing the time series to delete the assignable references from.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<>.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TryDeleteListAttributeAssignments(IListAttributeUnitReference, CancellationToken) Method
Section titled “ITimeSeriesStore.TryDeleteListAttributeAssignments(IListAttributeUnitReference, CancellationToken) Method”Attempts to delete all list attribute assignments where the given IListAttributeUnitReference is selected.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDeleteListAttributeAssignments(HAKOM.TSM.Net.Api.Attributes.Lists.Persistence.References.IListAttributeUnitReference listAttributeUnitReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”listAttributeUnitReference IListAttributeUnitReference
The IListAttributeUnitReference object referring to the selected IListAttributeUnitReference.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
An awaitable System.Threading.Tasks.Task<> of Result indicating deletion completion.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TryFind(bool, ITimeSeriesSearchParameters, Range<ITimeSeries>, IEnumerable<Order<ITimeSeries>>, CancellationToken) Method
Section titled “ITimeSeriesStore.TryFind(bool, ITimeSeriesSearchParameters, Range<ITimeSeries>, IEnumerable<Order<ITimeSeries>>, CancellationToken) Method”Finds time series as ITimeSeriesReference based on the given parameters, sorts them based on the given orderings and returns only a specified range from the results for pagination.
System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TryFind(bool includeAttributes, HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesSearchParameters? parameters=null, HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries> range=default(HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries>), System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries>>? orderings=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”includeAttributes System.Boolean
Decides if the results should contain assigned attributes and their related data.
parameters ITimeSeriesSearchParameters
The ITimeSeriesSearchParameters by which the search will be filtered.
range HAKOM.Persistence.Core.Net.Api.Paging.Range<ITimeSeries>
An optional System.Range by which the results should be limited.
orderings System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<ITimeSeries>>
A list of Order<TResult> by which the results will be ordered.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
An System.Collections.Generic.IAsyncEnumerable<> containing a Result<TValue>.
Remarks
Section titled “Remarks”Removes consecutive duplicate orderings, retaining only the last specified Direction for each.
ITimeSeriesStore.TryFind(ITimeSeriesSearchParameters, Range<ITimeSeries>, IEnumerable<Order<ITimeSeries>>, CancellationToken) Method
Section titled “ITimeSeriesStore.TryFind(ITimeSeriesSearchParameters, Range<ITimeSeries>, IEnumerable<Order<ITimeSeries>>, CancellationToken) Method”Finds time series as ITimeSeriesReference based on the given parameters, sorts them based on the given orderings and returns only a specified range from the results for pagination.
System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TryFind(HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesSearchParameters? parameters=null, HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries> range=default(HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries>), System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries>>? orderings=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”parameters ITimeSeriesSearchParameters
The ITimeSeriesSearchParameters by which the search will be filtered.
range HAKOM.Persistence.Core.Net.Api.Paging.Range<ITimeSeries>
An optional System.Range by which the results should be limited.
orderings System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<ITimeSeries>>
A list of Order<TResult> by which the results will be ordered.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
An System.Collections.Generic.IAsyncEnumerable<> containing a Result<TValue>.
Remarks
Section titled “Remarks”Removes consecutive duplicate orderings, retaining only the last specified Direction for each.
ITimeSeriesStore.TryFind(TimeSeriesResultContent, ITimeSeriesSearchParameters, Range<ITimeSeries>, IEnumerable<Order<ITimeSeries>>, CancellationToken) Method
Section titled “ITimeSeriesStore.TryFind(TimeSeriesResultContent, ITimeSeriesSearchParameters, Range<ITimeSeries>, IEnumerable<Order<ITimeSeries>>, CancellationToken) Method”Finds time series as ITimeSeriesReference based on the given parameters, sorts them based on the given orderings and returns only a specified range from the results for pagination.
System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TryFind(HAKOM.TSM.Net.Api.TimeSeries.Persistence.TimeSeriesResultContent content, HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesSearchParameters? parameters=null, HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries> range=default(HAKOM.Persistence.Core.Net.Api.Paging.Range<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries>), System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries>>? orderings=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”content TimeSeriesResultContent
Decides which data is loaded together with the time series definitions.
parameters ITimeSeriesSearchParameters
The ITimeSeriesSearchParameters by which the search will be filtered.
range HAKOM.Persistence.Core.Net.Api.Paging.Range<ITimeSeries>
An optional System.Range by which the results should be limited.
orderings System.Collections.Generic.IEnumerable<HAKOM.Persistence.Core.Net.Api.Ordering.Order<ITimeSeries>>
A list of Order<TResult> by which the results will be ordered.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
An System.Collections.Generic.IAsyncEnumerable<> containing a Result<TValue>.
Remarks
Section titled “Remarks”Removes consecutive duplicate orderings, retaining only the last specified Direction for each.
The default implementation serves None and Attributes through the System.Boolean overload with false and true. Any content including AttributeUnits or ListAttributeValues fails with an UnexpectedErrorException whose System.Exception.InnerException is a System.NotSupportedException. Implementations of this interface override this overload to provide the content.
ITimeSeriesStore.TryFindAssignments(IAttributeReference, IListAttributeUnitReference, CancellationToken) Method
Section titled “ITimeSeriesStore.TryFindAssignments(IAttributeReference, IListAttributeUnitReference, CancellationToken) Method”Try to get all assignments of given IAttributeReference and/or IListAttributeUnitReference to ITimeSeriesReferences.
System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<HAKOM.TSM.Net.Api.Attributes.IAttribute>>> TryFindAssignments(HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference? attributeReference, HAKOM.TSM.Net.Api.Attributes.Lists.Persistence.References.IListAttributeUnitReference? listAttributeUnitReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”attributeReference IAttributeReference
IAttributeReference for which to find assigned ITimeSeriesReference.
listAttributeUnitReference IListAttributeUnitReference
IListAttributeUnitReference for which to find ITimeSeriesReference to IAttributeReference assignments.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<IAttribute>>>
An System.Collections.Generic.IAsyncEnumerable<> of Result<TValue> of ITimeSeriesAssignmentReference<TAssigned>
of IAttribute.
Remarks
Section titled “Remarks”At least one of the parameters attributeReference, listAttributeUnitReference must be specified. If both are specified, the results will contain assignments that meet both requirements.
ITimeSeriesStore.TryFindAssignments<TAssigned>(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.TryFindAssignments<TAssigned>(ITimeSeriesReference, CancellationToken) Method”Gets all assignments from the given ITimeSeriesReference.
System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>>> TryFindAssignments<TAssigned>(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference from, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”from ITimeSeriesReference
The ITimeSeriesReference representing the time series to find the assignable references from.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>>>
An System.Collections.Generic.IAsyncEnumerable<> of a Result<TValue> of a ITimeSeriesAssignmentReference<TAssigned>.
ITimeSeriesStore.TryLoad(ITimeSeriesReference, TimeSeriesResultContent, CancellationToken) Method
Section titled “ITimeSeriesStore.TryLoad(ITimeSeriesReference, TimeSeriesResultContent, CancellationToken) Method”Loads a single time series as ITimeSeriesReference from storage together with the requested content.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TryLoad(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.TSM.Net.Api.TimeSeries.Persistence.TimeSeriesResultContent content, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The reference of the time series (ITimeSeriesReference) which will be reloaded.
content TimeSeriesResultContent
The TimeSeriesResultContent to be returned together with the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the ITimeSeriesReference object.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
The default implementation only supports None, where it behaves like TryLoad(ITimeSeriesReference, CancellationToken). Any other content fails with an UnexpectedErrorException whose System.Exception.InnerException is a System.NotSupportedException. Implementations of this interface override this overload to provide the content. Such an implementation queries storage for every content including Attributes, even when timeSeriesReference is already resolved.
ITimeSeriesStore.TryLoad(ITimeSeriesReference, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.TryLoad(ITimeSeriesReference, DateTimeOffset, CancellationToken) Method”Loads a single time series as ITimeSeriesReference from storage in the state from a specific date and time.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TryLoad(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The reference of the time series (ITimeSeriesReference) which will be reloaded.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the date and time of the state in which the time series is loaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the ITimeSeriesReference object.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TryLoad(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.TryLoad(ITimeSeriesReference, CancellationToken) Method”Loads a single time series as ITimeSeriesReference from storage.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TryLoad(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The reference of the time series (ITimeSeriesReference) which will be reloaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the ITimeSeriesReference object.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TryLoad(string, TimeSeriesResultContent, CancellationToken) Method
Section titled “ITimeSeriesStore.TryLoad(string, TimeSeriesResultContent, CancellationToken) Method”Loads a single time series as ITimeSeriesReference from storage together with the requested content.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TryLoad(string name, HAKOM.TSM.Net.Api.TimeSeries.Persistence.TimeSeriesResultContent content, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”name System.String
The unique name of the time series.
content TimeSeriesResultContent
The TimeSeriesResultContent to be returned together with the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the ITimeSeriesReference object.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
The default implementation only supports None, where it behaves like TryLoad(string, CancellationToken). Any other content fails with an UnexpectedErrorException whose System.Exception.InnerException is a System.NotSupportedException. Implementations of this interface override this overload to provide the content.
ITimeSeriesStore.TryLoad(string, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.TryLoad(string, DateTimeOffset, CancellationToken) Method”Loads a single time series as ITimeSeriesReference from storage in the state from a specific date and time.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TryLoad(string name, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”name System.String
The unique name of the time series.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the date and time of the state in which the time series is loaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the ITimeSeriesReference object.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TryLoad(string, CancellationToken) Method
Section titled “ITimeSeriesStore.TryLoad(string, CancellationToken) Method”Loads a single time series as ITimeSeriesReference from storage.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TryLoad(string name, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”name System.String
The unique name of the time series.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the ITimeSeriesReference object.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TryLoadAssignment<TAssigned>(IReference<TAssigned>, ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.TryLoadAssignment<TAssigned>(IReference<TAssigned>, ITimeSeriesReference, CancellationToken) Method”Attempts to load a single time series assignment as ITimeSeriesAssignmentReference<TAssigned> from storage.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>>> TryLoadAssignment<TAssigned>(HAKOM.Persistence.Core.Net.Api.References.IReference<TAssigned> assigned, HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference to, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”assigned HAKOM.Persistence.Core.Net.Api.References.IReference<TAssigned>
The IReference<TReferred> of the IAssignableToTimeSeries to load.
The ITimeSeriesReference representing the time series to load the assignable reference from.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>>>
A System.Threading.Tasks.Task<> containing the ITimeSeriesAssignmentReference<TAssigned> object.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TryLoadAssignment<TAssigned>(ITimeSeriesAssignmentReference<TAssigned>, CancellationToken) Method
Section titled “ITimeSeriesStore.TryLoadAssignment<TAssigned>(ITimeSeriesAssignmentReference<TAssigned>, CancellationToken) Method”Attempts to load a single time series assignment as ITimeSeriesAssignmentReference<TAssigned> from storage.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>>> TryLoadAssignment<TAssigned>(HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned> timeSeriesAssignmentReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”timeSeriesAssignmentReference HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>
The reference of the time series assignment (ITimeSeriesAssignmentReference<TAssigned>) which will be reloaded.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>>>
A System.Threading.Tasks.Task<> containing the ITimeSeriesAssignmentReference<TAssigned> object.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TryLoadBulk(IReadOnlyCollection<string>, TimeSeriesResultContent, CancellationToken) Method
Section titled “ITimeSeriesStore.TryLoadBulk(IReadOnlyCollection<string>, TimeSeriesResultContent, CancellationToken) Method”Loads several time series by their names together with the requested content, yielding one result per distinct name keyed by that name.
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.KeyValuePair<string,HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>>> TryLoadBulk(System.Collections.Generic.IReadOnlyCollection<string> names, HAKOM.TSM.Net.Api.TimeSeries.Persistence.TimeSeriesResultContent content, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”names System.Collections.Generic.IReadOnlyCollection<System.String>
The unique names of the time series.
content TimeSeriesResultContent
The TimeSeriesResultContent to be returned together with the time series definitions.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.KeyValuePair<System.String,HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>>
An System.Collections.Generic.IAsyncEnumerable<> of System.Collections.Generic.KeyValuePair<> pairing each distinct name with its
Result<TValue>.
Remarks
Section titled “Remarks”Every result is keyed by the name exactly as it was requested, and every distinct name gets exactly one result. Names are distinct ordinally, so names that differ only in case are two names, each answered as TryLoad(string, TimeSeriesResultContent, CancellationToken) answers it. A name requested twice gets one result. Results are streamed in completion order, which is not necessarily the order of names.
In the PowerTSM stores, a null name, or one longer than the name column of the database can hold, is answered with a TimeSeriesNotFoundException without querying it, because no time series can have it. The other names are loaded as usual.
A failure that belongs to a single time series fails only its own name. A failure of the operation as a whole, such as a denied authorization or a broken connection, fails every name that has not been answered yet.
The default implementation calls TryLoad(string, TimeSeriesResultContent, CancellationToken) for every distinct name, one after the other. Implementations of this interface override it to load many names with one query. The SQL stores bind up to 1000 names to one statement and run further statements for the rest.
ITimeSeriesStore.TrySave(ITimeSeries, IStorageInformation, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySave(ITimeSeries, IStorageInformation, DateTimeOffset, CancellationToken) Method”Tries to save a new time series with information about where its data is stored and further includes information about the exact point in time, at which the time series was in the given state.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySave(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySave(ITimeSeries, IStorageInformation, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySave(ITimeSeries, IStorageInformation, CancellationToken) Method”Tries to save a new time series with information about where its data is stored.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySave(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved.
dataStorageInformation IStorageInformation
The storage information specifying where the data for this time series will be stored.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySave(ITimeSeries, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySave(ITimeSeries, DateTimeOffset, CancellationToken) Method”Saves a new time series including information about the exact point in time, at which the time series was in the given state.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySave(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the
saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySave(ITimeSeries, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySave(ITimeSeries, CancellationToken) Method”Saves a new time series.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySave(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySave(ITimeSeriesReference, IStorageInformation, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySave(ITimeSeriesReference, IStorageInformation, DateTimeOffset, CancellationToken) Method”Tries to save a new time series based on a reference.
Further takes information about where its data is stored.
It includes information about the exact point in time, at which the time series was in the given state.
May be used to copy a time series to another repository.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySave(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be retrieved and saved.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySave(ITimeSeriesReference, IStorageInformation, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySave(ITimeSeriesReference, IStorageInformation, CancellationToken) Method”Tries to save a new time series based on a reference.
Further takes information about where its data is stored.
May be used to copy a time series to another repository.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySave(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeries to be saved.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySave(ITimeSeriesReference, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySave(ITimeSeriesReference, DateTimeOffset, CancellationToken) Method”Tries to save a new time series based on a reference.
It includes information about the exact point in time, at which the time series was in the given state.
May be used to copy a time series to another repository.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySave(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be retrieved and saved.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySave(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySave(ITimeSeriesReference, CancellationToken) Method”Tries to save a new time series based on a reference.
May be used to copy a time series to another repository.
The data storage will be the same as the original timeSeriesReference.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySave(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeries to be saved.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySaveAssignment<TAssigned>(IReference<TAssigned>, ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySaveAssignment<TAssigned>(IReference<TAssigned>, ITimeSeriesReference, CancellationToken) Method”Saves an assignment onto the given ITimeSeriesReference.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>>> TrySaveAssignment<TAssigned>(HAKOM.Persistence.Core.Net.Api.References.IReference<TAssigned> assigned, HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference to, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) where TAssigned : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeries;Type parameters
Section titled “Type parameters”TAssigned
Parameters
Section titled “Parameters”assigned HAKOM.Persistence.Core.Net.Api.References.IReference<TAssigned>
The IReference<TReferred> of the IAssignableToTimeSeries to store.
The ITimeSeriesReference representing the time series to store the assignable reference on.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<TAssigned>>>
A System.Threading.Tasks.Task<> containing the ITimeSeriesAssignmentReference<TAssigned> object.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySaveBulk(IReadOnlyDictionary<int,ITimeSeries>, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySaveBulk(IReadOnlyDictionary<int,ITimeSeries>, CancellationToken) Method”Saves multiple new time series in a single bulk operation, yielding one result per input item tagged with that item’s caller-assigned key.
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.KeyValuePair<int,HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>>> TrySaveBulk(System.Collections.Generic.IReadOnlyDictionary<int,HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries> items, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”items System.Collections.Generic.IReadOnlyDictionary<System.Int32,ITimeSeries>
The ITimeSeries items to save, keyed by a caller-assigned correlation handle.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.KeyValuePair<System.Int32,HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>>
An System.Collections.Generic.IAsyncEnumerable<> of System.Collections.Generic.KeyValuePair<> pairing each
input key with its Result<TValue>, one element per input key.
Remarks
Section titled “Remarks”The default implementation delegates to TrySave(ITimeSeries, CancellationToken) sequentially. Provider-specific overrides may execute the inserts in a single SQL statement for improved performance.
Results are streamed in completion order, which is not necessarily the order in which the items were supplied. Each result is correlated to its input via the System.Collections.Generic.KeyValuePair<>.Key, which is the key under which the item was supplied in items. Exactly one result is yielded per key.
ITimeSeriesStore.TrySaveOrUpdate(ITimeSeries, IStorageInformation, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySaveOrUpdate(ITimeSeries, IStorageInformation, DateTimeOffset, CancellationToken) Method”Tries to save or update the given time series.
Further takes information about where its data is stored.
It includes information about the exact point in time, at which the time series was in the given state.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved or updated.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySaveOrUpdate(ITimeSeries, IStorageInformation, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySaveOrUpdate(ITimeSeries, IStorageInformation, CancellationToken) Method”Saves or updates the given time series.
Further takes information about where its data is stored.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved or updated.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySaveOrUpdate(ITimeSeries, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySaveOrUpdate(ITimeSeries, DateTimeOffset, CancellationToken) Method”Tries to save or update the given time series. Includes information about the exact point in time, at which the time series was in the given state.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved or updated.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySaveOrUpdate(ITimeSeries, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySaveOrUpdate(ITimeSeries, CancellationToken) Method”Saves or updates the given time series.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeries ITimeSeries
The ITimeSeries to be saved or updated.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySaveOrUpdate(ITimeSeriesReference, IStorageInformation, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySaveOrUpdate(ITimeSeriesReference, IStorageInformation, DateTimeOffset, CancellationToken) Method”Tries to save or update the given time series based on a reference.
Further takes information about where its data is stored.
It includes information about the exact point in time, at which the time series was in the given state.
May be used to copy or update a time series from another repository.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be saved or updated.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySaveOrUpdate(ITimeSeriesReference, IStorageInformation, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySaveOrUpdate(ITimeSeriesReference, IStorageInformation, CancellationToken) Method”Tries to save or update the given time series based on a reference.
Further takes information about where its data is stored.
May be used to copy or update a time series from another repository.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be saved or updated.
dataStorageInformation IStorageInformation
The IStorageInformation the data will be saved on.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySaveOrUpdate(ITimeSeriesReference, DateTimeOffset, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySaveOrUpdate(ITimeSeriesReference, DateTimeOffset, CancellationToken) Method”Tries to save or update the given time series based on a reference.
It includes information about the exact point in time, at which the time series was in the given state.
May be used to copy or update a time series from another repository.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.DateTimeOffset historicDateTime, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be saved or updated.
historicDateTime System.DateTimeOffset
The System.DateTimeOffset object representing the historic date and time of saving the time series definition.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySaveOrUpdate(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySaveOrUpdate(ITimeSeriesReference, CancellationToken) Method”Tries to save or update the given time series based on a reference.
May be used to copy or update a time series from another repository.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference>> TrySaveOrUpdate(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to be saved or updated.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeriesReference>>
A System.Threading.Tasks.Task<> of Result<TValue> containing
the saved ITimeSeriesReference.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesStore.TrySaveOrUpdateListAttributeAssignment(IAttributeReference, ITimeSeriesReference, IListAttributeUnitReference, bool, CancellationToken) Method
Section titled “ITimeSeriesStore.TrySaveOrUpdateListAttributeAssignment(IAttributeReference, ITimeSeriesReference, IListAttributeUnitReference, bool, CancellationToken) Method”Attempts to save or update an assignment of an attribute of type ‘List’ onto the given ITimeSeriesReference.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<HAKOM.TSM.Net.Api.Attributes.IAttribute>>> TrySaveOrUpdateListAttributeAssignment(HAKOM.TSM.Net.Api.Attributes.Persistence.References.IAttributeReference assigned, HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference to, HAKOM.TSM.Net.Api.Attributes.Lists.Persistence.References.IListAttributeUnitReference listAttributeUnitReference, bool force=false, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”assigned IAttributeReference
The IAttributeReference of the list attribute to assign.
The ITimeSeriesReference representing the time series to assign the attribute to.
listAttributeUnitReference IListAttributeUnitReference
The IListAttributeUnitReference representing the unit of the list attribute.
force System.Boolean
Determines whether an assignment’s unit can be changed when it has existing data. When false (default) and data exists, an error will be returned and the unit will remain unchanged. If there is no data, the unit will be updated. When true, all data assigned to the assignment will be deleted and the unit will be updated.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<IAttribute>>>
An awaitable System.Threading.Tasks.Task<> representing the asynchronous operation. The Result<TValue>
contains information about success or failure and, if successful, a ITimeSeriesAssignmentReference<TAssigned>
referring to the assigned list attribute.