Table of Contents
- quixstreams
- quixstreams.app
- CancellationTokenSource
- App
- quixstreams.builders
- quixstreams.builders.eventdatabuilder
- EventDataBuilder
- quixstreams.builders.eventdefinitionbuilder
- EventDefinitionBuilder
- quixstreams.builders.parameterdefinitionbuilder
- ParameterDefinitionBuilder
- quixstreams.builders.timeseriesdatabuilder
- TimeseriesDataBuilder
- quixstreams.configuration
- quixstreams.configuration.saslmechanism
- quixstreams.configuration.securityoptions
- SecurityOptions
- quixstreams.exceptions.quixapiexception
- quixstreams.helpers
- quixstreams.helpers.dotnet.datetimeconverter
- DateTimeConverter
- quixstreams.helpers.enumconverter
- quixstreams.helpers.exceptionconverter
- quixstreams.helpers.nativedecorator
- quixstreams.helpers.timeconverter
- TimeConverter
- quixstreams.kafkastreamingclient
- KafkaStreamingClient
- quixstreams.logging
- quixstreams.models
- quixstreams.models.autooffsetreset
- AutoOffsetReset
- quixstreams.models.codecsettings
- CodecSettings
- quixstreams.models.codectype
- CodecType
- quixstreams.models.commitmode
- quixstreams.models.commitoptions
- CommitOptions
- quixstreams.models.eventdata
- EventData
- quixstreams.models.eventdefinition
- EventDefinition
- quixstreams.models.eventlevel
- quixstreams.models.netdict
- ReadOnlyNetDict
- NetDict
- quixstreams.models.netlist
- NetReadOnlyList
- NetList
- quixstreams.models.parameterdefinition
- ParameterDefinition
- quixstreams.models.parametervalue
- ParameterValue
- quixstreams.models.streamconsumer
- quixstreams.models.streamconsumer.streameventsconsumer
- StreamEventsConsumer
- quixstreams.models.streamconsumer.streampropertiesconsumer
- StreamPropertiesConsumer
- quixstreams.models.streamconsumer.streamtimeseriesconsumer
- StreamTimeseriesConsumer
- quixstreams.models.streamconsumer.timeseriesbufferconsumer
- TimeseriesBufferConsumer
- quixstreams.models.streamendtype
- quixstreams.models.streampackage
- StreamPackage
- quixstreams.models.streamproducer
- quixstreams.models.streamproducer.streameventsproducer
- StreamEventsProducer
- quixstreams.models.streamproducer.streampropertiesproducer
- StreamPropertiesProducer
- quixstreams.models.streamproducer.streamtimeseriesproducer
- StreamTimeseriesProducer
- quixstreams.models.streamproducer.timeseriesbufferproducer
- TimeseriesBufferProducer
- quixstreams.models.timeseriesbuffer
- TimeseriesBuffer
- __init__
- on_data_released
- on_data_released
- on_raw_released
- on_raw_released
- on_dataframe_released
- on_dataframe_released
- filter
- filter
- custom_trigger
- custom_trigger
- packet_size
- packet_size
- time_span_in_nanoseconds
- time_span_in_nanoseconds
- time_span_in_milliseconds
- time_span_in_milliseconds
- buffer_timeout
- buffer_timeout
- get_net_pointer
- quixstreams.models.timeseriesbufferconfiguration
- TimeseriesBufferConfiguration
- quixstreams.models.timeseriesdata
- TimeseriesData
- quixstreams.models.timeseriesdataraw
- TimeseriesDataRaw
- quixstreams.models.timeseriesdatatimestamp
- TimeseriesDataTimestamp
- quixstreams.native.Python.InteropHelpers.ExternalTypes.System.Array
- Array
- ReadBlittables
- WriteBlittables
- ReadArray
- WriteArray
- ReadNullables
- ReadLongs
- ReadLongsArray
- WriteLongs
- WriteLongsArray
- ReadStrings
- ReadStringsArray
- WriteStrings
- WriteStringsArray
- ReadDoubles
- ReadDoublesArray
- WriteDoubles
- WriteDoublesArray
- ReadPointers
- ReadPointersArray
- WritePointers
- WritePointersArray
- ReadBytes
- ReadBytesArray
- WriteBytes
- WriteBytesArray
- ReadNullableDoubles
- ReadNullableDoublesArray
- WriteNullableDoubles
- WriteNullableDoublesArray
- quixstreams.native.Python.InteropHelpers.ExternalTypes.System.Collection
- quixstreams.native.Python.InteropHelpers.ExternalTypes.System.Dictionary
- Dictionary
- ReadAnyHPtrToUPtr
- WriteBlittables
- ReadBlittables
- WriteStringPointers
- ReadStringPointers
- WriteStringDoublesArray
- ReadStringDoublesArray
- WriteStringLongsArray
- ReadStringLongsArray
- WriteStringStrings
- ReadStringStrings
- WriteStringStringsArray
- ReadStringStringsArray
- WriteStringBytesArray
- ReadStringBytesArray
- WriteStringNullableDoublesArray
- ReadStringNullableDoublesArray
- quixstreams.native.Python.InteropHelpers.ExternalTypes.System.Enumerable
- Enumerable
- quixstreams.native.Python.InteropHelpers.ExternalTypes.System.List
- quixstreams.native.Python.InteropHelpers.InteropUtils
- InteropUtils
- quixstreams.native.Python.MicrosoftExtensionsLoggingAbstractions.Microsoft.Extensions.Logging.LogLevel
- quixstreams.native.Python.QuixStreamsState.StateValue
- StateValue
- quixstreams.native.Python.QuixStreamsState.StateValue_StateType
- quixstreams.native.Python.QuixStreamsState.Storage.FileStorage.LocalFileStorage.LocalFileStorage
- LocalFileStorage
- quixstreams.native.Python.QuixStreamsState.Storage.IStateStorage
- IStateStorage
- quixstreams.native.Python.QuixStreamsState.Storage.StorageExtensions
- StorageExtensions
- quixstreams.native.Python.QuixStreamsStreaming.App
- App
- quixstreams.native.Python.QuixStreamsStreaming.Configuration.SaslMechanism
- quixstreams.native.Python.QuixStreamsStreaming.Configuration.SecurityOptions
- SecurityOptions
- quixstreams.native.Python.QuixStreamsStreaming.IStreamConsumer
- IStreamConsumer
- quixstreams.native.Python.QuixStreamsStreaming.IStreamProducer
- IStreamProducer
- quixstreams.native.Python.QuixStreamsStreaming.ITopicConsumer
- ITopicConsumer
- quixstreams.native.Python.QuixStreamsStreaming.ITopicProducer
- ITopicProducer
- quixstreams.native.Python.QuixStreamsStreaming.KafkaStreamingClient
- KafkaStreamingClient
- quixstreams.native.Python.QuixStreamsStreaming.KafkaStreamingClientExtensions
- KafkaStreamingClientExtensions
- quixstreams.native.Python.QuixStreamsStreaming.Models.CommitMode
- quixstreams.native.Python.QuixStreamsStreaming.Models.EventData
- EventData
- quixstreams.native.Python.QuixStreamsStreaming.Models.EventDefinition
- EventDefinition
- quixstreams.native.Python.QuixStreamsStreaming.Models.ParameterDefinition
- ParameterDefinition
- quixstreams.native.Python.QuixStreamsStreaming.Models.ParameterValue
- ParameterValue
- quixstreams.native.Python.QuixStreamsStreaming.Models.ParameterValueType
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.EventDataReadEventArgs
- EventDataReadEventArgs
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.EventDefinitionsChangedEventArgs
- EventDefinitionsChangedEventArgs
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.ParameterDefinitionsChangedEventArgs
- ParameterDefinitionsChangedEventArgs
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.StreamEventsConsumer
- StreamEventsConsumer
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.StreamPropertiesChangedEventArgs
- StreamPropertiesChangedEventArgs
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.StreamPropertiesConsumer
- StreamPropertiesConsumer
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.StreamTimeseriesConsumer
- StreamTimeseriesConsumer
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.TimeseriesBufferConsumer
- TimeseriesBufferConsumer
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.TimeseriesDataRawReadEventArgs
- TimeseriesDataRawReadEventArgs
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.TimeseriesDataReadEventArgs
- TimeseriesDataReadEventArgs
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.EventDataBuilder
- EventDataBuilder
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.EventDefinitionBuilder
- EventDefinitionBuilder
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.ParameterDefinitionBuilder
- ParameterDefinitionBuilder
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.StreamEventsProducer
- StreamEventsProducer
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.StreamPropertiesProducer
- StreamPropertiesProducer
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.StreamTimeseriesProducer
- StreamTimeseriesProducer
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.TimeseriesBufferProducer
- TimeseriesBufferProducer
- quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.TimeseriesDataBuilder
- TimeseriesDataBuilder
- quixstreams.native.Python.QuixStreamsStreaming.Models.TimeseriesBuffer
- TimeseriesBuffer
- __new__
- __init__
- add_OnDataReleased
- remove_OnDataReleased
- add_OnRawReleased
- remove_OnRawReleased
- get_PacketSize
- set_PacketSize
- get_BufferTimeout
- set_BufferTimeout
- get_TimeSpanInNanoseconds
- set_TimeSpanInNanoseconds
- get_TimeSpanInMilliseconds
- set_TimeSpanInMilliseconds
- get_Filter
- set_Filter
- get_CustomTriggerBeforeEnqueue
- set_CustomTriggerBeforeEnqueue
- get_CustomTrigger
- set_CustomTrigger
- Dispose
- quixstreams.native.Python.QuixStreamsStreaming.Models.TimeseriesBufferConfiguration
- TimeseriesBufferConfiguration
- __new__
- __init__
- Constructor
- get_PacketSize
- set_PacketSize
- get_TimeSpanInNanoseconds
- set_TimeSpanInNanoseconds
- get_TimeSpanInMilliseconds
- set_TimeSpanInMilliseconds
- get_CustomTriggerBeforeEnqueue
- set_CustomTriggerBeforeEnqueue
- get_CustomTrigger
- set_CustomTrigger
- get_Filter
- set_Filter
- get_BufferTimeout
- set_BufferTimeout
- quixstreams.native.Python.QuixStreamsStreaming.Models.TimeseriesData
- TimeseriesData
- quixstreams.native.Python.QuixStreamsStreaming.Models.TimeseriesDataTimestamp
- TimeseriesDataTimestamp
- quixstreams.native.Python.QuixStreamsStreaming.PackageReceivedEventArgs
- PackageReceivedEventArgs
- quixstreams.native.Python.QuixStreamsStreaming.QuixStreamingClient
- QuixStreamingClient
- quixstreams.native.Python.QuixStreamsStreaming.QuixStreamingClientExtensions
- QuixStreamingClientExtensions
- quixstreams.native.Python.QuixStreamsStreaming.QuixStreamingClient_TokenValidationConfiguration
- TokenValidationConfiguration
- quixstreams.native.Python.QuixStreamsStreaming.Raw.IRawTopicConsumer
- IRawTopicConsumer
- quixstreams.native.Python.QuixStreamsStreaming.Raw.IRawTopicProducer
- IRawTopicProducer
- quixstreams.native.Python.QuixStreamsStreaming.Raw.RawMessage
- RawMessage
- quixstreams.native.Python.QuixStreamsStreaming.Raw.RawTopicConsumer
- RawTopicConsumer
- quixstreams.native.Python.QuixStreamsStreaming.Raw.RawTopicProducer
- RawTopicProducer
- quixstreams.native.Python.QuixStreamsStreaming.StreamClosedEventArgs
- StreamClosedEventArgs
- quixstreams.native.Python.QuixStreamsStreaming.TimeseriesDataTimestampValues
- TimeseriesDataTimestampValues
- quixstreams.native.Python.QuixStreamsStreaming.TopicConsumer
- TopicConsumer
- quixstreams.native.Python.QuixStreamsStreaming.TopicProducer
- TopicProducer
- quixstreams.native.Python.QuixStreamsStreaming.Utils.CodecSettings
- CodecSettings
- quixstreams.native.Python.QuixStreamsStreaming.Utils.QuixUtils
- QuixUtils
- quixstreams.native.Python.QuixStreamsStreaming.Utils.TimeseriesDataTimestampTags
- TimeseriesDataTimestampTags
- quixstreams.native.Python.QuixStreamsStreaming.Utils.TimeseriesDataTimestamps
- TimeseriesDataTimestamps
- quixstreams.native.Python.QuixStreamsTelemetry.IStreamPipeline
- IStreamPipeline
- quixstreams.native.Python.QuixStreamsTelemetry.Kafka.AutoOffsetReset
- quixstreams.native.Python.QuixStreamsTelemetry.Kafka.KafkaProducerConfiguration
- KafkaProducerConfiguration
- quixstreams.native.Python.QuixStreamsTelemetry.Kafka.TelemetryKafkaConsumer
- TelemetryKafkaConsumer
- quixstreams.native.Python.QuixStreamsTelemetry.Kafka.TelemetryKafkaConsumerConfiguration
- TelemetryKafkaConsumerConfiguration
- quixstreams.native.Python.QuixStreamsTelemetry.Kafka.TelemetryKafkaProducer
- TelemetryKafkaProducer
- quixstreams.native.Python.QuixStreamsTelemetry.Models.CodecType
- quixstreams.native.Python.QuixStreamsTelemetry.Models.EventDefinition
- EventDefinition
- quixstreams.native.Python.QuixStreamsTelemetry.Models.EventLevel
- quixstreams.native.Python.QuixStreamsTelemetry.Models.ParameterDefinition
- ParameterDefinition
- quixstreams.native.Python.QuixStreamsTelemetry.Models.StreamEndType
- quixstreams.native.Python.QuixStreamsTelemetry.Models.StreamPackage
- StreamPackage
- quixstreams.native.Python.QuixStreamsTelemetry.Models.TimeseriesDataRaw
- TimeseriesDataRaw
- quixstreams.native.Python.QuixStreamsTransport.Fw.CommitOptions
- CommitOptions
- quixstreams.native.Python.QuixStreamsTransport.Fw.IByteSplitter
- IByteSplitter
- quixstreams.native.Python.QuixStreamsTransport.IO.IProducer
- IProducer
- quixstreams.native.Python.QuixStreamsTransport.IO.TransportContext
- TransportContext
- quixstreams.native.Python.QuixStreamsTransport.QuixStreams.Logging
- Logging
- quixstreams.native.Python.SystemNetHttp.HttpClient
- HttpClient
- quixstreams.native.Python.SystemNetPrimitives.System.Net.HttpStatusCode
- quixstreams.native.Python.SystemObjectModel.System.Collections.Specialized.NotifyCollectionChangedEventArgs
- NotifyCollectionChangedEventArgs
- quixstreams.native.Python.SystemObjectModel.System.ComponentModel.PropertyChangedEventArgs
- PropertyChangedEventArgs
- quixstreams.native.Python.SystemPrivateCoreLib.System.DateTime
- DateTime
- __new__
- __init__
- Constructor
- Constructor5
- Constructor8
- Constructor11
- Constructor14
- Add
- AddDays
- AddHours
- AddMilliseconds
- AddMicroseconds
- AddMinutes
- AddMonths
- AddSeconds
- AddTicks
- AddYears
- Compare
- CompareTo
- CompareTo2
- DaysInMonth
- Equals
- Equals2
- Equals3
- FromBinary
- FromFileTime
- FromFileTimeUtc
- FromOADate
- IsDaylightSavingTime
- ToBinary
- get_Date
- get_Day
- get_DayOfYear
- GetHashCode
- get_Hour
- get_Millisecond
- get_Microsecond
- get_Nanosecond
- get_Minute
- get_Month
- get_Now
- get_Second
- get_Ticks
- get_TimeOfDay
- get_Today
- get_Year
- IsLeapYear
- Parse
- Parse2
- ParseExact
- Subtract
- Subtract2
- ToOADate
- ToFileTime
- ToFileTimeUtc
- ToLocalTime
- ToLongDateString
- ToLongTimeString
- ToShortDateString
- ToShortTimeString
- ToString
- ToString2
- ToString3
- ToString4
- ToUniversalTime
- TryParse
- op_Equality
- op_Inequality
- Deconstruct2
- GetDateTimeFormats
- GetDateTimeFormats2
- GetTypeCode
- TryParse5
- get_UtcNow
- get_MinValue
- get_MaxValue
- get_UnixEpoch
- quixstreams.native.Python.SystemPrivateCoreLib.System.Enum
- Enum
- quixstreams.native.Python.SystemPrivateCoreLib.System.IFormatProvider
- IFormatProvider
- quixstreams.native.Python.SystemPrivateCoreLib.System.Threading.CancellationToken
- CancellationToken
- quixstreams.native.Python.SystemPrivateCoreLib.System.Threading.CancellationTokenSource
- CancellationTokenSource
- quixstreams.native.Python.SystemPrivateCoreLib.System.TimeSpan
- TimeSpan
- __init__
- Constructor
- Constructor2
- Constructor3
- Constructor4
- Constructor5
- get_Ticks
- get_Days
- get_Hours
- get_Milliseconds
- get_Microseconds
- get_Nanoseconds
- get_Minutes
- get_Seconds
- get_TotalDays
- get_TotalHours
- get_TotalMilliseconds
- get_TotalMicroseconds
- get_TotalNanoseconds
- get_TotalMinutes
- get_TotalSeconds
- Add
- Compare
- CompareTo
- CompareTo2
- FromDays
- Duration
- Equals
- Equals2
- Equals3
- GetHashCode
- FromHours
- FromMilliseconds
- FromMicroseconds
- FromMinutes
- Negate
- FromSeconds
- Subtract
- Multiply
- Divide
- Divide2
- FromTicks
- Parse
- Parse2
- ParseExact
- ParseExact2
- TryParse
- TryParse3
- TryParseExact
- TryParseExact3
- ToString
- ToString2
- ToString3
- op_Equality
- op_Inequality
- get_Zero
- get_MaxValue
- get_MinValue
- get_NanosecondsPerTick
- get_TicksPerMicrosecond
- get_TicksPerMillisecond
- get_TicksPerSecond
- get_TicksPerMinute
- get_TicksPerHour
- get_TicksPerDay
- quixstreams.native.Python.SystemPrivateCoreLib.System.Type
- Type
- __new__
- __init__
- get_IsInterface
- GetType
- GetType2
- GetType3
- GetType7
- get_Namespace
- get_AssemblyQualifiedName
- get_FullName
- get_IsNested
- get_DeclaringType
- get_ReflectedType
- get_UnderlyingSystemType
- get_IsTypeDefinition
- get_IsArray
- get_IsByRef
- get_IsPointer
- get_IsConstructedGenericType
- get_IsGenericParameter
- get_IsGenericTypeParameter
- get_IsGenericMethodParameter
- get_IsGenericType
- get_IsGenericTypeDefinition
- get_IsSZArray
- get_IsVariableBoundArray
- get_IsByRefLike
- get_IsFunctionPointer
- get_IsUnmanagedFunctionPointer
- get_HasElementType
- GetElementType
- GetArrayRank
- GetGenericTypeDefinition
- get_GenericTypeArguments
- GetGenericArguments
- GetOptionalCustomModifiers
- GetRequiredCustomModifiers
- get_GenericParameterPosition
- GetGenericParameterConstraints
- get_IsAbstract
- get_IsImport
- get_IsSealed
- get_IsSpecialName
- get_IsClass
- get_IsNestedAssembly
- get_IsNestedFamANDAssem
- get_IsNestedFamily
- get_IsNestedFamORAssem
- get_IsNestedPrivate
- get_IsNestedPublic
- get_IsNotPublic
- get_IsPublic
- get_IsAutoLayout
- get_IsExplicitLayout
- get_IsLayoutSequential
- get_IsAnsiClass
- get_IsAutoClass
- get_IsUnicodeClass
- get_IsCOMObject
- get_IsContextful
- get_IsEnum
- get_IsMarshalByRef
- get_IsPrimitive
- get_IsValueType
- IsAssignableTo
- get_IsSignatureType
- get_IsSecurityCritical
- get_IsSecuritySafeCritical
- get_IsSecurityTransparent
- GetFunctionPointerCallingConventions
- GetFunctionPointerReturnType
- GetFunctionPointerParameterTypes
- GetNestedType
- GetNestedTypes
- GetTypeArray
- GetTypeCode
- GetTypeFromProgID
- GetTypeFromProgID2
- GetTypeFromProgID3
- GetTypeFromProgID4
- get_BaseType
- GetInterface
- GetInterface2
- GetInterfaces
- IsInstanceOfType
- IsEquivalentTo
- GetEnumUnderlyingType
- GetEnumValues
- GetEnumValuesAsUnderlyingType
- MakeArrayType
- MakeArrayType2
- MakeByRefType
- MakeGenericType
- MakePointerType
- MakeGenericSignatureType
- MakeGenericMethodParameter
- ToString
- Equals
- GetHashCode
- Equals2
- op_Equality
- op_Inequality
- ReflectionOnlyGetType
- IsEnumDefined
- GetEnumName
- GetEnumNames
- get_IsSerializable
- get_ContainsGenericParameters
- get_IsVisible
- IsSubclassOf
- IsAssignableFrom
- get_Name
- IsDefined
- GetCustomAttributes
- GetCustomAttributes2
- get_IsCollectible
- get_MetadataToken
- get_EmptyTypes
- get_Missing
- quixstreams.native.Python.SystemPrivateCoreLib.System.TypeCode
- quixstreams.native.Python.SystemPrivateUri.System.Uri
- Uri
- __new__
- __init__
- Constructor
- Constructor2
- Constructor3
- Constructor6
- Constructor7
- get_AbsolutePath
- get_AbsoluteUri
- get_LocalPath
- get_Authority
- get_IsDefaultPort
- get_IsFile
- get_IsLoopback
- get_PathAndQuery
- get_Segments
- get_IsUnc
- get_Host
- get_Port
- get_Query
- get_Fragment
- get_Scheme
- get_OriginalString
- get_DnsSafeHost
- get_IdnHost
- get_IsAbsoluteUri
- get_UserEscaped
- get_UserInfo
- IsHexEncoding
- CheckSchemeName
- GetHashCode
- ToString
- op_Equality
- op_Inequality
- Equals
- MakeRelativeUri
- MakeRelative
- TryCreate3
- TryCreate4
- IsWellFormedOriginalString
- UnescapeDataString
- EscapeUriString
- EscapeDataString
- IsBaseOf
- get_UriSchemeFile
- get_UriSchemeFtp
- get_UriSchemeSftp
- get_UriSchemeFtps
- get_UriSchemeGopher
- get_UriSchemeHttp
- get_UriSchemeHttps
- get_UriSchemeWs
- get_UriSchemeWss
- get_UriSchemeMailto
- get_UriSchemeNews
- get_UriSchemeNntp
- get_UriSchemeSsh
- get_UriSchemeTelnet
- get_UriSchemeNetTcp
- get_UriSchemeNetPipe
- get_SchemeDelimiter
- quixstreams.quixstreamingclient
- TokenValidationConfiguration
- QuixStreamingClient
- quixstreams.raw
- quixstreams.raw.rawmessage
- RawMessage
- quixstreams.raw.rawtopicconsumer
- RawTopicConsumer
- quixstreams.raw.rawtopicproducer
- RawTopicProducer
- quixstreams.state
- quixstreams.state.inmemorystorage
- InMemoryStorage
- quixstreams.state.localfilestorage
- LocalFileStorage
- quixstreams.state.statetype
- quixstreams.state.statevalue
- StateValue
- quixstreams.streamconsumer
- StreamConsumer
- quixstreams.streamproducer
- StreamProducer
- quixstreams.topicconsumer
- TopicConsumer
- quixstreams.topicproducer
- TopicProducer
quixstreams
quixstreams.app
CancellationTokenSource Objects
Represents a token source that can signal a cancellation System.Threading.CancellationToken
__init__
Initializes a new instance of the CancellationTokenSource class.
is_cancellation_requested
Checks if a cancellation has been requested.
Returns:
bool
- True if the cancellation has been requested, False otherwise.
cancel
Signals a cancellation to the CancellationToken.
token
Gets the associated CancellationToken.
Returns:
CancellationToken
- The CancellationToken associated with this CancellationTokenSource.
get_net_pointer
Gets the interop pointer of the CancellationTokenSource object.
Returns:
ctypes.c_void_p
- The interop pointer of the CancellationTokenSource object.
App Objects
Provides utilities to handle default streaming behaviors and automatic resource cleanup on shutdown.
run
@staticmethod
def run(cancellation_token: CancellationToken = None,
before_shutdown: Callable[[], None] = None)
Runs the application, managing streaming behaviors and automatic resource cleanup on shutdown.
Arguments:
cancellation_token
- An optional CancellationToken to abort the application run with.before_shutdown
- An optional function to call before shutting down the application.
quixstreams.builders
quixstreams.builders.eventdatabuilder
EventDataBuilder Objects
Builder for creating event data packages for StreamEventsProducer.
__init__
Initializes a new instance of EventDataBuilder.
Arguments:
net_pointer
- Pointer to an instance of a .net EventDataBuilder.
add_value
Adds new event at the time the builder is created for.
Arguments:
event_id
- The id of the event to set the value for.value
- The string value.
Returns:
The builder.
add_tag
Sets tag value for the values.
Arguments:
tag_id
- The id of the tag.value
- The value of the tag.
Returns:
The builder.
add_tags
Copies the tags from the specified dictionary. Conflicting tags will be overwritten.
Arguments:
tags
- The tags to add.
Returns:
The builder.
publish
Publishes the values to the StreamEventsProducer buffer.
See StreamEventsProducer buffer settings for more information on when the values are sent to the broker.
quixstreams.builders.eventdefinitionbuilder
EventDefinitionBuilder Objects
Builder for creating EventDefinitions within StreamPropertiesProducer.
__init__
Initializes a new instance of EventDefinitionBuilder.
Arguments:
net_pointer
- Pointer to an instance of a .net EventDefinitionBuilder.
set_level
Set severity level of the Event.
Arguments:
level
- The severity level of the event.
Returns:
The builder.
set_custom_properties
Set custom properties of the Event.
Arguments:
custom_properties
- The custom properties of the event.
Returns:
The builder.
add_definition
def add_definition(event_id: str,
name: str = None,
description: str = None) -> 'EventDefinitionBuilder'
Add new Event definition, to define properties like Name or Level, among others.
Arguments:
event_id
- Event id. This must match the event id you use to publish event values.name
- Human friendly display name of the event.description
- Description of the event.
Returns:
Event definition builder to define the event properties.
quixstreams.builders.parameterdefinitionbuilder
ParameterDefinitionBuilder Objects
Builder for creating ParameterDefinition for StreamTimeseriesProducer.
__init__
Initializes a new instance of ParameterDefinitionBuilder.
Arguments:
net_pointer
- Pointer to an instance of a .net ParameterDefinitionBuilder.
set_range
Set the minimum and maximum range of the parameter.
Arguments:
minimum_value
- The minimum value.maximum_value
- The maximum value.
Returns:
The builder.
set_unit
Set the unit of the parameter.
Arguments:
unit
- The unit of the parameter.
Returns:
The builder.
set_format
Set the format of the parameter.
Arguments:
format
- The format of the parameter.
Returns:
The builder.
set_custom_properties
Set the custom properties of the parameter.
Arguments:
custom_properties
- The custom properties of the parameter.
Returns:
The builder.
add_definition
def add_definition(parameter_id: str,
name: str = None,
description: str = None) -> 'ParameterDefinitionBuilder'
Add new parameter definition to the StreamTimeseriesProducer. Configure it with the builder methods.
Arguments:
parameter_id
- The id of the parameter. Must match the parameter id used to send data.name
- The human friendly display name of the parameter.description
- The description of the parameter.
Returns:
Parameter definition builder to define the parameter properties
quixstreams.builders.timeseriesdatabuilder
TimeseriesDataBuilder Objects
Builder for managing TimeseriesDataTimestamp instances on TimeseriesBufferProducer.
__init__
Initializes a new instance of TimeseriesDataBuilder.
Arguments:
net_pointer
- Pointer to an instance of a .net TimeseriesDataBuilder.
add_value
def add_value(
parameter_id: str, value: Union[str, float, int, bytes,
bytearray]) -> 'TimeseriesDataBuilder'
Adds new parameter value at the time the builder is created for.
Arguments:
parameter_id
- The id of the parameter to set the value for.value
- The value of type string, float, int, bytes, or bytearray.
Returns:
The builder.
add_tag
Adds a tag to the values.
Arguments:
tag_id
- The id of the tag.value
- The value of the tag.
Returns:
The builder.
add_tags
Copies the tags from the specified dictionary. Conflicting tags will be overwritten.
Arguments:
tags
- The tags to add.
Returns:
The builder.
publish
Publish the values.
quixstreams.configuration
quixstreams.configuration.saslmechanism
quixstreams.configuration.securityoptions
SecurityOptions Objects
A class representing security options for configuring SSL encryption with SASL authentication in Kafka.
__init__
def __init__(ssl_certificates: str,
username: str,
password: str,
sasl_mechanism: SaslMechanism = SaslMechanism.ScramSha256)
Initializes a new instance of SecurityOptions configured for SSL encryption with SASL authentication.
Arguments:
ssl_certificates
- The path to the folder or file containing the certificate authority certificate(s) used to validate the SSL connection.Example
- "./certificates/ca.cert"username
- The username for SASL authentication.password
- The password for SASL authentication.sasl_mechanism
- The SASL mechanism to use. Defaults to ScramSha256.
get_net_pointer
Retrieves the .NET pointer for the current SecurityOptions instance.
Returns:
ctypes.c_void_p
- The .NET pointer.
quixstreams.exceptions.quixapiexception
quixstreams.helpers
quixstreams.helpers.dotnet.datetimeconverter
DateTimeConverter Objects
datetime_to_python
Converts dotnet pointer to DateTime and frees the pointer.
Arguments:
hptr
- Handler Pointer to .Net type DateTime
Returns:
datetime.datetime: Python type datetime
datetime_to_dotnet
Arguments:
value
- Python type datetime
Returns:
ctypes.c_void_p: Handler Pointer to .Net type DateTime
timespan_to_python
Converts dotnet pointer to Timespan as binary and frees the pointer.
Arguments:
uptr
- Pointer to .Net type TimeSpan
Returns:
datetime.timedelta: Python type timedelta
timedelta_to_dotnet
Arguments:
value
- Python type timedelta
Returns:
ctypes.c_void_p: Pointer to unmanaged memory containing TimeSpan
quixstreams.helpers.enumconverter
quixstreams.helpers.exceptionconverter
quixstreams.helpers.nativedecorator
quixstreams.helpers.timeconverter
TimeConverter Objects
A utility class for converting between different time representations.
offset_from_utc
The local time ahead of utc by this amount of nanoseconds
to_unix_nanoseconds
Converts a datetime object to UNIX timestamp in nanoseconds.
Arguments:
value
- The datetime object to be converted.
Returns:
int
- The UNIX timestamp in nanoseconds.
to_nanoseconds
Converts a timedelta object to nanoseconds.
Arguments:
value
- The timedelta object to be converted.
Returns:
int
- The duration in nanoseconds.
from_nanoseconds
Converts a duration in nanoseconds to a timedelta object.
Arguments:
value
- The duration in nanoseconds.
Returns:
timedelta
- The corresponding timedelta object.
from_unix_nanoseconds
Converts a UNIX timestamp in nanoseconds to a datetime object.
Arguments:
value
- The UNIX timestamp in nanoseconds.
Returns:
datetime
- The corresponding datetime object.
from_string
Converts a string representation of a timestamp to a UNIX timestamp in nanoseconds.
Arguments:
value
- The string representation of a timestamp.
Returns:
int
- The corresponding UNIX timestamp in nanoseconds.
quixstreams.kafkastreamingclient
KafkaStreamingClient Objects
A Kafka streaming client capable of creating topic consumer and producers.
__init__
def __init__(broker_address: str,
security_options: SecurityOptions = None,
properties: Dict[str, str] = None,
debug: bool = False)
Initializes a new instance of the KafkaStreamingClient.
Arguments:
broker_address
- The address of the Kafka cluster.security_options
- Optional security options for the Kafka client.properties
- Optional extra properties for broker configuration.debug
- Whether debugging should be enabled. Defaults to False.
get_topic_consumer
def get_topic_consumer(
topic: str,
consumer_group: str = None,
commit_settings: Union[CommitOptions, CommitMode] = None,
auto_offset_reset: AutoOffsetReset = AutoOffsetReset.Latest
) -> TopicConsumer
Gets a topic consumer capable of subscribing to receive incoming streams.
Arguments:
topic
- The name of the topic.consumer_group
- The consumer group ID to use for consuming messages. Defaults to None.commit_settings
- The settings to use for committing. If not provided, defaults to committing every 5000 messages or 5 seconds, whichever is sooner.auto_offset_reset
- The offset to use when there is no saved offset for the consumer group. Defaults to AutoOffsetReset.Latest.
Returns:
TopicConsumer
- An instance of TopicConsumer for the specified topic.
get_topic_producer
Gets a topic producer capable of publishing stream messages.
Arguments:
topic
- The name of the topic.
Returns:
TopicProducer
- An instance of TopicProducer for the specified topic.
get_raw_topic_consumer
def get_raw_topic_consumer(
topic: str,
consumer_group: str = None,
auto_offset_reset: Union[AutoOffsetReset,
None] = None) -> RawTopicConsumer
Gets a topic consumer capable of subscribing to receive non-quixstreams incoming messages.
Arguments:
topic
- The name of the topic.consumer_group
- The consumer group ID to use for consuming messages. Defaults to None.auto_offset_reset
- The offset to use when there is no saved offset for the consumer group. Defaults to None.
Returns:
RawTopicConsumer
- An instance of RawTopicConsumer for the specified topic.
get_raw_topic_producer
Gets a topic producer capable of publishing non-quixstreams messages.
Arguments:
topic
- The name of the topic.
Returns:
RawTopicProducer
- An instance of RawTopicProducer for the specified topic.
quixstreams.logging
quixstreams.models
quixstreams.models.autooffsetreset
AutoOffsetReset Objects
Enum representing the policy on how a consumer should behave when consuming from a topic partition when there is no initial offset.
Latest
Latest: Starts from the newest message if there is no stored offset.
Earliest
Earliest: Starts from the oldest message if there is no stored offset.
Error
Error: Throws an exception if there is no stored offset.
quixstreams.models.codecsettings
CodecSettings Objects
Global Codec settings for streams.
set_global_codec_type
Sets the codec type to be used by producers and transfer package value serialization.
quixstreams.models.codectype
CodecType Objects
Codecs available for serialization and deserialization of streams.
quixstreams.models.commitmode
quixstreams.models.commitoptions
CommitOptions Objects
__init__
Initializes a new instance of CommitOptions
Arguments:
net_pointer
: Pointer to an instance of a .net CommitOptions.
auto_commit_enabled
Gets whether automatic committing is enabled. If automatic committing is not enabled, other values are ignored. Default is True.
auto_commit_enabled
Sets whether automatic committing is enabled. If automatic committing is not enabled, other values are ignored. Default is True.
commit_interval
Gets the interval of automatic commit in ms. Default is 5000.
commit_interval
Sets the interval of automatic commit in ms. Default is 5000.
commit_every
Gets the number of messages to automatically commit at. Default is 5000.
commit_every
Sets the number of messages to automatically commit at. Default is 5000.
quixstreams.models.eventdata
EventData Objects
Represents a single point in time with event value and tags attached to it.
__init__
def __init__(event_id: str = None,
time: Union[int, str, datetime, pd.Timestamp] = None,
value: str = None,
net_pointer: ctypes.c_void_p = None)
Initializes a new instance of EventData.
Arguments:
event_id
- The unique id of the event the value belongs to.time
- The time at which the event has occurred in nanoseconds since epoch or as a datetime.value
- The value of the event.net_pointer
- Pointer to an instance of a .net EventData.
id
Gets the globally unique identifier of the event.
id
Sets the globally unique identifier of the event.
value
Gets the value of the event.
value
Sets the value of the event.
tags
Gets the tags for the timestamp.
If a key is not found, it returns None. The dictionary key is the tag id. The dictionary value is the tag value.
timestamp_nanoseconds
Gets timestamp in nanoseconds.
timestamp_milliseconds
Gets timestamp in milliseconds.
timestamp
Gets the timestamp in datetime format.
timestamp_as_time_span
Gets the timestamp in timespan format.
clone
Clones the event data.
Returns:
EventData
- Cloned EventData object.
add_tag
Adds a tag to the event.
Arguments:
tag_id
- The id of the tag.tag_value
- The value to set.
Returns:
EventData
- The updated EventData object.
add_tags
Adds tags from the specified dictionary. Conflicting tags will be overwritten.
Arguments:
tags
- The tags to add.
Returns:
EventData
- The updated EventData object.
remove_tag
Removes a tag from the event.
Arguments:
tag_id
- The id of the tag to remove.
Returns:
EventData
- The updated EventData object.
get_net_pointer
Gets the associated .net object pointer.
Returns:
The .net object pointer.
quixstreams.models.eventdefinition
EventDefinition Objects
Describes additional context for the event
__init__
Initializes a new instance of EventDefinition
NOTE: Do not initialize this class manually. Instances of it are available on StreamEventsConsumer.definitions
Arguments:
net_pointer
: Pointer to an instance of a .net EventDefinition
quixstreams.models.eventlevel
quixstreams.models.netdict
ReadOnlyNetDict Objects
Experimental. Acts as a proxy between a .net dictionary and a python dict. Useful if .net dictionary is observable and reacts to changes
NetDict Objects
Experimental. Acts as a proxy between a .net dictionary and a python list.
constructor_for_string_string
Creates an empty dotnet list for strings if no pointer provided, else wraps in NetDict with string converters
quixstreams.models.netlist
NetReadOnlyList Objects
Experimental. Acts as a proxy between a .net collection and a python list. Useful if .net collection is observable and reacts to changes
NetList Objects
Experimental. Acts as a proxy between a .net collection and a python list. Useful if .net collection is observable and reacts to changes
constructor_for_string
Creates an empty dotnet list for strings if no pointer provided, else wraps in NetDict with string converters
quixstreams.models.parameterdefinition
ParameterDefinition Objects
Describes additional context for the parameter
__init__
Initializes a new instance of ParameterDefinition
NOTE: Do not initialize this class manually. Instances of it are available on StreamTimeseriesConsumer.definitions
Arguments:
net_pointer
: Pointer to an instance of a .net ParameterDefinition.
quixstreams.models.parametervalue
ParameterValue Objects
Represents a single parameter value of either numeric, string, or binary type.
__init__
Initializes a new instance of ParameterValue.
Arguments:
net_pointer
- The .net object pointer representing ParameterValue.
numeric_value
Gets the numeric value of the parameter if the underlying parameter is of numeric type.
numeric_value
Sets the numeric value of the parameter and updates the type to numeric.
Arguments:
value
- The numeric value to set.
string_value
Gets the string value of the parameter if the underlying parameter is of string type.
string_value
Sets the string value of the parameter and updates the type to string.
Arguments:
value
- The string value to set.
binary_value
Gets the binary value of the parameter if the underlying parameter is of binary type.
binary_value
Sets the binary value of the parameter and updates the type to binary.
Arguments:
value
- The binary value to set.
type
Gets the type of value, which is numeric, string, binary if set, otherwise empty
value
Gets the underlying value.
get_net_pointer
Gets the associated .net object pointer.
quixstreams.models.streamconsumer
quixstreams.models.streamconsumer.streameventsconsumer
StreamEventsConsumer Objects
Consumer for streams, which raises EventData and EventDefinitions related messages
__init__
Initializes a new instance of StreamEventsConsumer. NOTE: Do not initialize this class manually, use StreamConsumer.events to access an instance of it
Arguments:
stream_consumer
- The Stream consumer which owns this stream event consumernet_pointer
- Pointer to an instance of a .net StreamEventsConsumer
on_data_received
Gets the handler for when an events data package is received for the stream.
Returns:
Callable[['StreamConsumer', EventData], None]: The first parameter is the stream the event is received for. The second is the event.
on_data_received
@on_data_received.setter
def on_data_received(
value: Callable[['StreamConsumer', EventData], None]) -> None
Sets the handler for when an events data package is received for the stream.
Arguments:
value
- The first parameter is the stream the event is received for. The second is the event.
on_definitions_changed
Gets the handler for event definitions have changed for the stream.
Returns:
Callable[['StreamConsumer'], None]: The first parameter is the stream the event definitions changed for.
on_definitions_changed
@on_definitions_changed.setter
def on_definitions_changed(value: Callable[['StreamConsumer'], None]) -> None
Sets the handler for event definitions have changed for the stream.
Arguments:
value
- The first parameter is the stream the event definitions changed for.
definitions
Gets the latest set of event definitions.
quixstreams.models.streamconsumer.streampropertiesconsumer
StreamPropertiesConsumer Objects
Represents properties and metadata of the stream. All changes to these properties are automatically populated to this class.
__init__
Initializes a new instance of StreamPropertiesConsumer. NOTE: Do not initialize this class manually, use StreamConsumer.properties to access an instance of it.
Arguments:
stream_consumer
- The Stream consumer that owns this stream event consumer.net_pointer
- Pointer to an instance of a .NET StreamPropertiesConsumer.
on_changed
Gets the handler for when the stream properties change.
Returns:
Callable[[StreamConsumer], None]: The event handler for stream property changes. The first parameter is the StreamConsumer instance for which the change is invoked.
on_changed
Sets the handler for when the stream properties change.
Arguments:
value
- The first parameter is the stream it is invoked for.
name
Gets the name of the stream.
location
Gets the location of the stream.
time_of_recording
Gets the datetime of the recording.
metadata
Gets the metadata of the stream.
parents
Gets the list of Stream IDs for the parent streams.
get_net_pointer
Gets the .NET pointer for the StreamPropertiesConsumer instance.
Returns:
ctypes.c_void_p
- .NET pointer for the StreamPropertiesConsumer instance.
quixstreams.models.streamconsumer.streamtimeseriesconsumer
StreamTimeseriesConsumer Objects
Consumer for streams, which raises TimeseriesData and ParameterDefinitions related messages
__init__
Initializes a new instance of StreamTimeseriesConsumer. NOTE: Do not initialize this class manually. Use StreamConsumer.timeseries to access an instance of it.
Arguments:
stream_consumer
- The Stream consumer which owns this stream event consumer.net_pointer
.net object - Pointer to an instance of a .net StreamTimeseriesConsumer.
on_data_received
Gets the handler for when data is received (without buffering).
Returns:
Callable[['StreamConsumer', TimeseriesData], None]: The function that handles the data received. The first parameter is the stream that receives the data, and the second is the data in TimeseriesData format.
on_data_received
@on_data_received.setter
def on_data_received(
value: Callable[['StreamConsumer', TimeseriesData], None]) -> None
Sets the handler for when data is received (without buffering).
Arguments:
value
- The function that handles the data received. The first parameter is the stream that receives the data, and the second is the data in TimeseriesData format.
on_raw_received
Gets the handler for when data is received (without buffering) in raw transport format.
Returns:
Callable[['StreamConsumer', TimeseriesDataRaw], None]: The function that handles the data received. The first parameter is the stream that receives the data, and the second is the data in TimeseriesDataRaw format.
on_raw_received
@on_raw_received.setter
def on_raw_received(
value: Callable[['StreamConsumer', TimeseriesDataRaw], None]) -> None
Sets the handler for when data is received (without buffering) in raw transport format.
Arguments:
value
- The function that handles the data received. The first parameter is the stream that receives the data, and the second is the data in TimeseriesDataRaw format.
on_dataframe_received
Gets the handler for when data is received (without buffering) in pandas DataFrame format.
Returns:
Callable[['StreamConsumer', pandas.DataFrame], None]: The function that handles the data received. The first parameter is the stream that receives the data, and the second is the data in pandas DataFrame format.
on_dataframe_received
@on_dataframe_received.setter
def on_dataframe_received(
value: Callable[['StreamConsumer', pandas.DataFrame], None]) -> None
Sets the handler for when data is received (without buffering) in pandas DataFrame format.
Arguments:
value
- The function that handles the data received. The first parameter is the stream that receives the data, and the second is the data in pandas DataFrame format.
on_definitions_changed
Gets the handler for when the parameter definitions have changed for the stream.
Returns:
Callable[['StreamConsumer'], None]: The function that handles the parameter definitions change. The first parameter is the stream for which the parameter definitions changed.
on_definitions_changed
@on_definitions_changed.setter
def on_definitions_changed(value: Callable[['StreamConsumer'], None]) -> None
Sets the handler for when the parameter definitions have changed for the stream.
Arguments:
value
- The function that handles the parameter definitions change. The first parameter is the stream for which the parameter definitions changed.
definitions
Gets the latest set of parameter definitions.
create_buffer
def create_buffer(
*parameter_filter: str,
buffer_configuration: TimeseriesBufferConfiguration = None
) -> TimeseriesBufferConsumer
Creates a new buffer for consuming data according to the provided parameter_filter and buffer_configuration.
Arguments:
parameter_filter
- Zero or more parameter identifiers to filter as a whitelist. If provided, only those parameters will be available through this buffer.buffer_configuration
- An optional TimeseriesBufferConfiguration.
Returns:
TimeseriesBufferConsumer
- An consumer that will raise new data consumed via the on_data_released event.
get_net_pointer
Gets the .NET pointer for the StreamTimeseriesConsumer instance.
Returns:
ctypes.c_void_p
- .NET pointer for the StreamTimeseriesConsumer instance.
quixstreams.models.streamconsumer.timeseriesbufferconsumer
TimeseriesBufferConsumer Objects
Represents a class for consuming data from a stream in a buffered manner.
__init__
Initializes a new instance of TimeseriesBufferConsumer.
NOTE: Do not initialize this class manually, use StreamTimeseriesConsumer.create_buffer to create it.
Arguments:
stream_consumer
- The Stream consumer which owns this timeseries buffer consumer.net_pointer
- Pointer to an instance of a .net TimeseriesBufferConsumer. Defaults to None.
Raises:
Exception
- If net_pointer is None.
get_net_pointer
Retrieves the pointer to the .net TimeseriesBufferConsumer instance.
Returns:
ctypes.c_void_p
- The pointer to the .net TimeseriesBufferConsumer instance.
quixstreams.models.streamendtype
quixstreams.models.streampackage
StreamPackage Objects
Default model implementation for non-typed message packages of the Telemetry layer. It holds a value and its type.
__init__
Initializes a new instance of StreamPackage.
Notes:
Do not initialize this class manually. Will be initialized by StreamConsumer.on_package_received.
Arguments:
net_pointer
- Pointer to an instance of a .net StreamPackage.
transport_context
Context holder for package when transporting through the pipeline.
to_json
Serialize the package into JSON.
Returns:
str
- The serialized JSON string of the package.
get_net_pointer
Gets the associated .net object pointer.
Returns:
ctypes.c_void_p
- The .net object pointer.
quixstreams.models.streamproducer
quixstreams.models.streamproducer.streameventsproducer
StreamEventsProducer Objects
Helper class for producing EventDefinitions and EventData.
__init__
Initializes a new instance of StreamEventsProducer.
Arguments:
net_pointer
- Pointer to an instance of a .NET StreamEventsProducer.
flush
Immediately publishes the event definitions from the buffer without waiting for buffer condition to fulfill (200ms timeout). TODO: Verify 200ms timeout value.
default_tags
Gets default tags injected to all event values sent by the producer.
default_location
Gets the default Location of the events. Event definitions added with add_definition will be inserted at this location. See add_location for adding definitions at a different location without changing default. Example: "/Group1/SubGroup2"
default_location
Sets the default Location of the events. Event definitions added with add_definition will be inserted at this location. See add_location for adding definitions at a different location without changing default.
Arguments:
value
- Location string, e.g., "/Group1/SubGroup2".
epoch
The unix epoch from, which all other timestamps in this model are measured from in nanoseconds.
epoch
Sets the default epoch used for event values.
publish
Publish an event into the stream.
Arguments:
data
- EventData object or a pandas dataframe.columns
- Column names if the dataframe has different columns from 'id', 'timestamp', and 'value'. For instance, if 'id' is in the column 'event_id', id='event_id' must be passed as an argument.
Raises:
TypeError
- If the data argument is neither an EventData nor pandas dataframe.
add_timestamp
Start adding a new set of event values at the given timestamp.
Arguments:
time
- The time to use for adding new event values.- datetime: The datetime to use for adding new event values. NOTE, epoch is not used.
- timedelta: The time since the default epoch to add the event values at
Returns:
EventDataBuilder
- Event data builder to add event values at the provided time.
add_timestamp_milliseconds
Start adding a new set of event values at the given timestamp.
Arguments:
milliseconds
- The time in milliseconds since the default epoch to add the event values at.
Returns:
EventDataBuilder
- Event data builder to add event values at the provided time.
add_timestamp_nanoseconds
Start adding a new set of event values at the given timestamp.
Arguments:
nanoseconds
- The time in nanoseconds since the default epoch to add the event values at.
Returns:
EventDataBuilder
- Event data builder to add event values at the provided time.
add_definition
def add_definition(event_id: str,
name: str = None,
description: str = None) -> EventDefinitionBuilder
Add new Event definition to define properties like Name or Level, among others.
Arguments:
event_id
- The id of the event. Must match the event id used to send data.name
- The human-friendly display name of the event.description
- The description of the event.
Returns:
EventDefinitionBuilder
- EventDefinitionBuilder to define properties of the event or add additional events.
add_location
Add a new location in the events groups hierarchy.
Arguments:
location
- The group location.
Returns:
EventDefinitionBuilder
- EventDefinitionBuilder to define the events under the specified location.
quixstreams.models.streamproducer.streampropertiesproducer
StreamPropertiesProducer Objects
Represents properties and metadata of the stream. All changes to these properties are automatically published to the underlying stream.
__init__
Initializes a new instance of StreamPropertiesProducer.
Arguments:
net_pointer
- Pointer to an instance of a .net StreamPropertiesProducer.
name
Gets the human friendly name of the stream.
Returns:
str
- The human friendly name of the stream.
name
Sets the human friendly name of the stream.
Arguments:
value
- The new human friendly name of the stream.
location
Gets the location of the stream in the data catalogue.
Returns:
str
- The location of the stream in the data catalogue, e.g., "/cars/ai/carA/".
location
Sets the location of the stream in the data catalogue.
Arguments:
value
- The new location of the stream in the data catalogue.
metadata
" Gets the metadata of the stream.
Returns:
Dict[str, str]: The metadata of the stream.
parents
Gets the list of stream ids of the parent streams.
Returns:
List[str]
- The list of stream ids of the parent streams.
time_of_recording
Gets the datetime of the stream recording.
Returns:
datetime
- The datetime of the stream recording.
time_of_recording
Sets the time of the stream recording.
Arguments:
value
- The new time of the stream recording.
flush_interval
Gets the automatic flush interval of the properties metadata into the channel (in milliseconds).
Returns:
int
- The automatic flush interval in milliseconds, default is 30000.
flush_interval
Sets the automatic flush interval of the properties metadata into the channel (in milliseconds).
Arguments:
value
- The new flush interval in milliseconds.
flush
Immediately publishes the properties yet to be sent instead of waiting for the flush timer (20ms).
quixstreams.models.streamproducer.streamtimeseriesproducer
StreamTimeseriesProducer Objects
Helper class for producing ParameterDefinition and TimeseriesData.
__init__
Initializes a new instance of StreamTimeseriesProducer.
Arguments:
stream_producer
- The Stream producer which owns this stream timeseries producer.net_pointer
- Pointer to an instance of a .net StreamTimeseriesProducer.
flush
Immediately publish timeseries data and definitions from the buffer without waiting for buffer condition to fulfill for either.
add_definition
def add_definition(parameter_id: str,
name: str = None,
description: str = None) -> ParameterDefinitionBuilder
Add new parameter definition to the StreamTimeseriesProducer. Configure it with the builder methods.
Arguments:
parameter_id
- The id of the parameter. Must match the parameter id used to send data.name
- The human friendly display name of the parameter.description
- The description of the parameter.
Returns:
ParameterDefinitionBuilder
- Builder to define the parameter properties.
add_location
Add a new location in the parameters groups hierarchy.
Arguments:
location
- The group location.
Returns:
ParameterDefinitionBuilder
- Builder to define the parameters under the specified location.
default_location
Gets the default location of the parameters. Parameter definitions added with add_definition will be inserted at this location. See add_location for adding definitions at a different location without changing default.
Returns:
str
- The default location of the parameters, e.g., "/Group1/SubGroup2".
default_location
Sets the default location of the parameters. Parameter definitions added with add_definition will be inserted at this location. See add_location for adding definitions at a different location without changing default.
Arguments:
value
- The new default location of the parameters, e.g., "/Group1/SubGroup2".
buffer
Get the buffer for producing timeseries data.
Returns:
TimeseriesBufferProducer
- The buffer for producing timeseries data.
publish
Publish the given packet to the stream without any buffering.
Arguments:
packet
- The packet containing TimeseriesData, TimeseriesDataRaw, or pandas DataFrame.
Notes:
- Pandas DataFrame should contain 'time' label, else the first integer label will be taken as time.
- Tags should be prefixed by TAG__ or they will be treated as parameters.
Examples:
Send a pandas DataFrame:
pdf = pandas.DataFrame({'time': [1, 5],
- 'panda_param'
- [123.2, 5]})
instance.publish(pdf)
Send a pandas DataFrame with multiple values:
pdf = pandas.DataFrame({'time': [1, 5, 10],
- 'panda_param'
- [123.2, None, 12],
- 'panda_param2'
- ["val1", "val2", None]})
instance.publish(pdf)
Send a pandas DataFrame with tags:
pdf = pandas.DataFrame({'time': [1, 5, 10],
- 'panda_param'
- [123.2, 5, 12],
- 'TAG__Tag1'
- ["v1", 2, None],
- 'TAG__Tag2'
- [1, None, 3]})
instance.publish(pdf)
Raises:
Exception
- If the given type is not supported for publishing.
quixstreams.models.streamproducer.timeseriesbufferproducer
TimeseriesBufferProducer Objects
A class for producing timeseries data to a StreamProducer in a buffered manner.
__init__
Initializes a new instance of TimeseriesBufferProducer. NOTE: Do not initialize this class manually, use StreamTimeseriesProducer.buffer to access an instance of it
Arguments:
stream_producer
- The Stream producer which owns this timeseries buffer producernet_pointer
- Pointer to an instance of a .net TimeseriesBufferProducer
Raises:
Exception
- If TimeseriesBufferProducer is None
default_tags
Get default tags injected for all parameters values sent by this buffer.
Returns:
Dict[str, str]: A dictionary containing the default tags
epoch
Get the default epoch used for parameter values.
Returns:
datetime
- The default epoch used for parameter values
epoch
Set the default epoch used for parameter values. Datetime added on top of all the Timestamps.
Arguments:
value
- The default epoch to set for parameter values
add_timestamp
Start adding a new set of parameter values at the given timestamp.
Arguments:
time
- The time to use for adding new parameter values.- datetime: The datetime to use for adding new parameter values. NOTE, epoch is not used
- timedelta: The time since the default epoch to add the parameter values at
Returns:
TimeseriesDataBuilder
- A TimeseriesDataBuilder instance for adding parameter values
Raises:
ValueError
- If 'time' is None or not an instance of datetime or timedelta
add_timestamp_nanoseconds
Start adding a new set of parameter values at the given timestamp.
Arguments:
nanoseconds
- The time in nanoseconds since the default epoch to add the parameter values at
Returns:
TimeseriesDataBuilder
- A TimeseriesDataBuilder instance for adding parameter values
flush
Immediately publishes the data from the buffer without waiting for the buffer condition to be fulfilled.
publish
Publish the provided timeseries packet to the buffer.
Arguments:
packet
- The packet containing TimeseriesData or panda DataFrame- packet type panda.DataFrame:
- Note 1: panda data frame should contain 'time' label, else the first integer label will be taken as time.
- Note 2: Tags should be prefixed by TAG__ or they will be treated as timeseries parameters
Examples:
Send a panda data frame:
pdf = panda.DataFrame({'time': [1, 5],
- 'panda_param'
- [123.2, 5]})
instance.publish(pdf)
Send a panda data frame with multiple values:
pdf = panda.DataFrame({'time': [1, 5, 10],
- 'panda_param'
- [123.2, None, 12],
- 'panda_param2'
- ["val1", "val2", None]})
instance.publish(pdf)
Send a panda data frame with tags:
pdf = panda.DataFrame({'time': [1, 5, 10],
- 'panda_param'
- [123.2, 5, 12],,
- 'TAG__Tag1'
- ["v1", 2, None],
- 'TAG__Tag2'
- [1, None, 3]})
instance.publish(pdf)
Raises:
Exception
- If the packet type is not supported
quixstreams.models.timeseriesbuffer
TimeseriesBuffer Objects
Represents a class used to consume and produce stream messages in a buffered manner. When buffer conditions are not configured, it acts a pass-through, raising each message as arrives.
__init__
Initializes a new instance of TimeseriesBuffer.
NOTE: Do not initialize this class manually, use StreamProducer.timeseries.buffer to create it.
Arguments:
stream
- The stream the buffer is created for.net_pointer
- Pointer to a .net TimeseriesBuffer object.
on_data_released
@property
def on_data_released() -> Callable[
[Union['StreamConsumer', 'StreamProducer'], TimeseriesData], None]
Gets the handler for when the stream receives data.
Returns:
Callable[[Union['StreamConsumer', 'StreamProducer'], TimeseriesData], None]: The event handler. The first parameter is the stream the data is received for, second is the data in TimeseriesData format.
on_data_released
@on_data_released.setter
def on_data_released(
value: Callable[
[Union['StreamConsumer', 'StreamProducer'], TimeseriesData], None]
) -> None
Sets the handler for when the stream receives data.
Arguments:
value
- The event handler. The first parameter is the stream the data is received for, second is the data in TimeseriesData format.
on_raw_released
@property
def on_raw_released() -> Callable[
[Union['StreamConsumer', 'StreamProducer'], TimeseriesDataRaw], None]
Gets the handler for when the stream receives raw data.
Returns:
Callable[[Union['StreamConsumer', 'StreamProducer'], TimeseriesDataRaw], None]: The event handler. The first parameter is the stream the data is received for, second is the data in TimeseriesDataRaw format.
on_raw_released
@on_raw_released.setter
def on_raw_released(
value: Callable[
[Union['StreamConsumer', 'StreamProducer'], TimeseriesDataRaw], None]
) -> None
Sets the handler for when the stream receives raw data.
Arguments:
value
- The event handler. The first parameter is the stream the data is received for, second is the data in TimeseriesDataRaw format.
on_dataframe_released
@property
def on_dataframe_released() -> Callable[
[Union['StreamConsumer', 'StreamProducer'], pandas.DataFrame], None]
Gets the handler for when the stream receives data as a pandas DataFrame.
Returns:
Callable[[Union['StreamConsumer', 'StreamProducer'], pandas.DataFrame], None]: The event handler. The first parameter is the stream the data is received for, second is the data in pandas.DataFrame format.
on_dataframe_released
@on_dataframe_released.setter
def on_dataframe_released(
value: Callable[
[Union['StreamConsumer', 'StreamProducer'], pandas.DataFrame], None]
) -> None
Sets the handler for when the stream receives data as a pandas DataFrame.
Arguments:
value
- The event handler. The first parameter is the stream the data is received for, second is the data in pandas.DataFrame format.
filter
Gets the custom function to filter the incoming data before adding it to the buffer. If returns true, data is added otherwise not. Defaults to none (disabled).
filter
Sets the custom function to filter incoming data before adding to the buffer.
The custom function takes a TimeseriesDataTimestamp object as input and returns a boolean value. If the function returns True, the data is added to the buffer, otherwise not. By default, this feature is disabled (None).
Arguments:
value
- Custom filter function.
custom_trigger
Gets the custom trigger function, which is invoked after adding a new timestamp to the buffer.
If the custom trigger function returns True, the buffer releases content and triggers relevant callbacks. By default, this feature is disabled (None).
Returns:
Callable[[TimeseriesData], bool]: Custom trigger function.
custom_trigger
Sets the custom trigger function, which is invoked after adding a new timestamp to the buffer.
If the custom trigger function returns True, the buffer releases content and triggers relevant callbacks. By default, this feature is disabled (None).
Arguments:
value
- Custom trigger function.
packet_size
Gets the maximum packet size in terms of values for the buffer.
Each time the buffer has this amount of data, a callback method, such as on_data_released
,
is invoked, and the data is cleared from the buffer. By default, this feature
is disabled (None).
Returns:
Optional[int]
- Maximum packet size for the buffer.
packet_size
Sets the maximum packet size in terms of values for the buffer.
Each time the buffer has this amount of data, a callback method, such as on_data_released
,
is invoked, and the data is cleared from the buffer. By default, this feature
is disabled (None).
Arguments:
value
- Maximum packet size for the buffer.
time_span_in_nanoseconds
Gets the maximum time between timestamps for the buffer in nanoseconds.
When the difference between the earliest and latest buffered timestamp surpasses
this number, a callback method, such as on_data_released
, is invoked, and the data is cleared
from the buffer. By default, this feature is disabled (None).
Returns:
Optional[int]
- Maximum time between timestamps in nanoseconds.
time_span_in_nanoseconds
Sets the maximum time between timestamps for the buffer in nanoseconds.
When the difference between the earliest and latest buffered timestamp surpasses
this number, a callback method, such as on_data_released
, is invoked, and the data is cleared
from the buffer. By default, this feature is disabled (None).
Arguments:
value
- Maximum time between timestamps in nanoseconds.
time_span_in_milliseconds
Gets the maximum time between timestamps for the buffer in milliseconds.
This property retrieves the maximum time between the earliest and latest buffered timestamp in milliseconds. If the difference surpasses this number, a callback method, such as on_data_released, is invoked, and the data is cleared from the buffer. Note that this property is a millisecond converter on top of time_span_in_nanoseconds, and both work with the same underlying value. Defaults to None (disabled).
Returns:
Optional[int]
- The maximum time difference between timestamps in milliseconds, or None if disabled.
time_span_in_milliseconds
Sets the maximum time between timestamps for the buffer in milliseconds.
This property sets the maximum time between the earliest and latest buffered timestamp in milliseconds. If the difference surpasses this number, a callback method, such as on_data_released, is invoked, and the data is cleared from the buffer. Note that this property is a millisecond converter on top of time_span_in_nanoseconds, and both work with the same underlying value. Defaults to None (disabled).
Arguments:
value
- The maximum time difference between timestamps in milliseconds, or None to disable.
buffer_timeout
Gets the maximum duration in milliseconds for which the buffer will be held. When the configured value has elapsed or other buffer conditions are met, a callback method, such as on_data_released, is invoked. Defaults to None (disabled).
Returns:
Optional[int]
- The maximum duration in milliseconds before invoking a callback method, or None if disabled.
buffer_timeout
Sets the maximum duration in milliseconds for which the buffer will be held. When the configured value has elapsed or other buffer conditions are met, a callback method, such as on_data_released, is invoked. Defaults to None (disabled).
Arguments:
value
- The maximum duration in milliseconds before invoking a callback method, or None to disable.
get_net_pointer
Gets the associated .net object pointer.
Returns:
ctypes.c_void_p
- The .net object pointer.
quixstreams.models.timeseriesbufferconfiguration
TimeseriesBufferConfiguration Objects
Describes the configuration for timeseries buffers When buffer conditions are not configured, it acts a pass-through, raising each message as arrives.
__init__
Initializes a new instance of TimeseriesBufferConfiguration.
Arguments:
net_pointer
- Can be ignored, here for internal purposes .net object: The .net object representing a TimeseriesBufferConfiguration. Defaults to None.
packet_size
Gets the maximum packet size in terms of values for the buffer.
When the buffer reaches this number of values, a callback method, such as on_data_released, is invoked and the buffer is cleared. If not set, defaults to None (disabled).
Returns:
Optional[int]
- The maximum packet size in values or None if disabled.
packet_size
Sets the maximum packet size in terms of values for the buffer.
When the buffer reaches this number of values, a callback method, such as on_data_released, is invoked and the buffer is cleared. If not set, defaults to None (disabled).
Arguments:
value
- The maximum packet size in values or None to disable.
time_span_in_nanoseconds
Gets the maximum time difference between timestamps in the buffer, in nanoseconds.
When the difference between the earliest and latest buffered timestamp exceeds this value, a callback method, such as on_data_released, is invoked and the data is cleared from the buffer. If not set, defaults to None (disabled).
Returns:
Optional[int]
- The maximum time span in nanoseconds or None if disabled.
time_span_in_nanoseconds
Sets the maximum time difference between timestamps in the buffer, in nanoseconds.
When the difference between the earliest and latest buffered timestamp exceeds this value, a callback method, such as on_data_released, is invoked and the data is cleared from the buffer. If not set, defaults to None (disabled).
Arguments:
value
- The maximum time span in nanoseconds or None to disable.
time_span_in_milliseconds
Gets the maximum time difference between timestamps in the buffer, in milliseconds.
When the difference between the earliest and latest buffered timestamp exceeds this value, a callback method, such as on_data_released, is invoked and the data is cleared from the buffer. If not set, defaults to None (disabled).
Note: This is a millisecond converter on top of time_span_in_nanoseconds. They both work with the same underlying value.
Returns:
Optional[int]
- The maximum time span in milliseconds or None if disabled.
time_span_in_milliseconds
Sets the maximum time difference between timestamps in the buffer, in milliseconds.
When the difference between the earliest and latest buffered timestamp exceeds this value, a callback method, such as on_data_released, is invoked and the data is cleared from the buffer. If not set, defaults to None (disabled).
Arguments:
value
- The maximum time span in nanoseconds or None to disable.
buffer_timeout
Gets the maximum duration for which the buffer will be held before releasing the events through callbacks, such as on_data_released.
A callback will be invoked once the configured value has elapsed or other buffer conditions are met. If not set, defaults to None (disabled).
Returns:
Optional[int]
- The maximum buffer timeout in milliseconds or None if disabled.
buffer_timeout
Sets the maximum duration for which the buffer will be held before releasing the events through callbacks, such as on_data_released.
A callback will be invoked once the configured value has elapsed or other buffer conditions are met. If not set, defaults to None (disabled).
Arguments:
value
- The maximum buffer timeout in milliseconds or None to disable.
custom_trigger_before_enqueue
Gets the custom function that is called before adding a timestamp to the buffer.
If the function returns True, the buffer releases content and triggers relevant callbacks before adding the timestamp to the buffer. If not set, defaults to None (disabled).
Returns:
Callable[[TimeseriesDataTimestamp], bool]: The custom function or None if disabled.
custom_trigger_before_enqueue
@custom_trigger_before_enqueue.setter
def custom_trigger_before_enqueue(value: Callable[[TimeseriesDataTimestamp],
bool])
Sets the custom function that is called before adding a timestamp to the buffer.
If the function returns True, the buffer releases content and triggers relevant callbacks before adding the timestamp to the buffer. If not set, defaults to None (disabled).
Arguments:
value
- The custom function or None to disable.
filter
Gets the custom function used to filter incoming data before adding it to the buffer.
If the function returns True, the data is added to the buffer; otherwise, it is not. If not set, defaults to None (disabled).
Returns:
Callable[[TimeseriesDataTimestamp], bool]: The custom filter function or None if disabled.
filter
Sets the custom function used to filter incoming data before adding it to the buffer.
If the function returns True, the data is added to the buffer; otherwise, it is not. If not set, defaults to None (disabled).
Arguments:
value
- The custom filter function or None to disable.
custom_trigger
Gets the custom function that is called after adding a new timestamp to the buffer.
If the function returns True, the buffer releases content and triggers relevant callbacks. If not set, defaults to None (disabled).
Returns:
Callable[[TimeseriesData], bool]: The custom trigger function or None if disabled.
custom_trigger
Sets the custom function that is called after adding a new timestamp to the buffer.
If the function returns True, the buffer releases content and triggers relevant callbacks. If not set, defaults to None (disabled).
Arguments:
value
- The custom trigger function or None to disable.
get_net_pointer
Returns the .net pointer for the TimeseriesBufferConfiguration object.
Returns:
ctypes.c_void_p
- The .net pointer for the TimeseriesBufferConfiguration object.
quixstreams.models.timeseriesdata
TimeseriesData Objects
Describes timeseries data for multiple timestamps.
__init__
Initializes a new instance of TimeseriesData.
Arguments:
net_pointer
- Pointer to an instance of a .net TimeseriesData.
clone
Initializes a new instance of timeseries data with parameters matching the filter if one is provided.
Arguments:
parameter_filter
- The parameter filter. If one is provided, only parameters present in the list will be cloned.
Returns:
TimeseriesData
- A new instance of TimeseriesData with filtered parameters.
add_timestamp
Start adding a new set of parameters and their tags at the specified time.
Arguments:
time
- The time to use for adding new event values. | datetime: The datetime to use for adding new event values. Epoch will never be added to this | timedelta: The time since the default epoch to add the event values at
Returns:
TimeseriesDataTimestamp
- A new TimeseriesDataTimestamp instance.
add_timestamp_milliseconds
Start adding a new set of parameters and their tags at the specified time.
Arguments:
milliseconds
- The time in milliseconds since the default epoch to add the event values at.
Returns:
TimeseriesDataTimestamp
- A new TimeseriesDataTimestamp instance.
add_timestamp_nanoseconds
Start adding a new set of parameters and their tags at the specified time.
Arguments:
nanoseconds
- The time in nanoseconds since the default epoch to add the event values at.
Returns:
TimeseriesDataTimestamp
- A new TimeseriesDataTimestamp instance.
timestamps
Gets the data as rows of TimeseriesDataTimestamp.
Returns:
List[TimeseriesDataTimestamp]
- A list of TimeseriesDataTimestamp instances.
timestamps
Sets the data as rows of TimeseriesDataTimestamp.
Arguments:
timestamp_list
- A list of TimeseriesDataTimestamp instances to set.
to_dataframe
Converts TimeseriesData to pandas DataFrame.
Returns:
pd.DataFrame
- Converted pandas DataFrame.
from_panda_dataframe
@staticmethod
def from_panda_dataframe(data_frame: pd.DataFrame,
epoch: int = 0) -> 'TimeseriesData'
Converts pandas DataFrame to TimeseriesData.
Arguments:
data_frame
- The pandas DataFrame to convert to TimeseriesData.epoch
- The epoch to add to each time value when converting to TimeseriesData. Defaults to 0.
Returns:
TimeseriesData
- Converted TimeseriesData instance.
get_net_pointer
Gets the .net pointer of the current instance.
Returns:
ctypes.c_void_p
- The .net pointer of the current instance
quixstreams.models.timeseriesdataraw
TimeseriesDataRaw Objects
Describes timeseries data in a raw format for multiple timestamps. Class is intended for read only.
__init__
Initializes a new instance of TimeseriesDataRaw.
Arguments:
net_pointer
- Pointer to an instance of a .net TimeseriesDataRaw. Defaults to None.
to_dataframe
Converts TimeseriesDataRaw to pandas DataFrame.
Returns:
pd.DataFrame
- Converted pandas DataFrame.
from_dataframe
Converts from pandas DataFrame to TimeseriesDataRaw.
Arguments:
data_frame
- The pandas DataFrame to convert to TimeseriesData.epoch
- The epoch to add to each time value when converting to TimeseriesData. Defaults to 0.
Returns:
TimeseriesDataRaw
- Converted TimeseriesDataRaw.
set_values
def set_values(epoch: int, timestamps: List[int],
numeric_values: Dict[str, List[float]],
string_values: Dict[str, List[str]],
binary_values: Dict[str,
List[bytes]], tag_values: Dict[str,
List[str]])
Sets the values of the timeseries data from the provided dictionaries. Dictionary values are matched by index to the provided timestamps.
Arguments:
epoch
- The time from which all timestamps are measured from.timestamps
- The timestamps of values in nanoseconds since epoch as an array.numeric_values
- The numeric values where the dictionary key is the parameter name and the value is the array of values.string_values
- The string values where the dictionary key is the parameter name and the value is the array of values.binary_values
- The binary values where the dictionary key is the parameter name and the value is the array of values.tag_values
- The tag values where the dictionary key is the parameter name and the value is the array of values.
epoch
The Unix epoch from which all other timestamps in this model are measured, in nanoseconds.
Returns:
int
- The Unix epoch (01/01/1970) in nanoseconds.
timestamps
The timestamps of values in nanoseconds since the epoch. Timestamps are matched by index to numeric_values, string_values, binary_values, and tag_values.
Returns:
List[int]
- A list of timestamps in nanoseconds since the epoch.
numeric_values
The numeric values for parameters. The key is the parameter ID the values belong to. The value is the numerical values of the parameter. Values are matched by index to timestamps.
Returns:
Dict[str, List[Optional[float]]]: A dictionary mapping parameter IDs to lists of numerical values.
string_values
The string values for parameters. The key is the parameter ID the values belong to. The value is the string values of the parameter. Values are matched by index to timestamps.
Returns:
Dict[str, List[str]]: A dictionary mapping parameter IDs to lists of string values
binary_values
The binary values for parameters. The key is the parameter ID the values belong to. The value is the binary values of the parameter. Values are matched by index to timestamps.
Returns:
Dict[str, List[bytes]]: A dictionary mapping parameter IDs to lists of bytes values
tag_values
The tag values for parameters. The key is the parameter ID the values belong to. The value is the tag values of the parameter. Values are matched by index to timestamps.
Returns:
Dict[str, List[str]]: A dictionary mapping parameter IDs to lists of string values
convert_to_timeseriesdata
Converts TimeseriesDataRaw to TimeseriesData
quixstreams.models.timeseriesdatatimestamp
TimeseriesDataTimestamp Objects
Represents a single point in time with parameter values and tags attached to that time.
__init__
Initializes a new instance of TimeseriesDataTimestamp.
Arguments:
net_pointer
- Pointer to an instance of a .net TimeseriesDataTimestamp.
parameters
Gets the parameter values for the timestamp as a dictionary. If a key is not found, returns an empty ParameterValue.
Returns:
Dict[str, ParameterValue]: A dictionary with parameter id as key and ParameterValue as value.
tags
Gets the tags for the timestamp as a dictionary.
Returns:
Dict[str, str]: A dictionary with tag id as key and tag value as value.
timestamp_nanoseconds
Gets the timestamp in nanoseconds.
Returns:
int
- The timestamp in nanoseconds.
timestamp_milliseconds
Gets the timestamp in milliseconds.
Returns:
int
- The timestamp in milliseconds.
timestamp
Gets the timestamp in datetime format.
Returns:
datetime
- The timestamp in datetime format.
timestamp_as_time_span
Gets the timestamp in timespan format.
Returns:
timedelta
- The timestamp in timespan format.
add_value
def add_value(
parameter_id: str, value: Union[numbers.Number, str, bytearray, bytes]
) -> 'TimeseriesDataTimestamp'
Adds a new value for the specified parameter.
Arguments:
parameter_id
- The parameter id to add the value for.value
- The value to add. Can be a number, string, bytearray, or bytes.
Returns:
TimeseriesDataTimestamp
- The updated TimeseriesDataTimestamp instance.
remove_value
Removes the value for the specified parameter.
Arguments:
parameter_id
- The parameter id to remove the value for.
Returns:
TimeseriesDataTimestamp
- The updated TimeseriesDataTimestamp instance.
add_tag
Adds a tag to the timestamp.
Arguments:
tag_id
- The id of the tag to add.tag_value
- The value of the tag to add.
Returns:
TimeseriesDataTimestamp
- The updated TimeseriesDataTimestamp instance.
remove_tag
Removes a tag from the timestamp.
Arguments:
tag_id
- The id of the tag to remove.
Returns:
TimeseriesDataTimestamp
- The updated TimeseriesDataTimestamp instance.
add_tags
Copies the tags from the specified dictionary. Conflicting tags will be overwritten.
Arguments:
tags
- The dictionary of tags to add, with tag id as key and tag value as value.
Returns:
TimeseriesDataTimestamp
- The updated TimeseriesDataTimestamp instance.
get_net_pointer
Gets the .net pointer of the TimeseriesDataTimestamp instance.
Returns:
ctypes.c_void_p
- The .net pointer of the TimeseriesDataTimestamp instance.
quixstreams.native.Python.InteropHelpers.ExternalTypes.System.Array
Array Objects
ReadBlittables
Reads blittable values starting from the array pointer using the specified type and mapper then frees the pointer
Arguments:
array_uptr
: Unmanaged memory pointer to the first element of the array.valuetype
: Type of the valuevaluemapper
: Conversion function for the value
Returns:
The converted array to the given type using the mapper
WriteBlittables
Writes a list of blittables (like int) into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
ReadArray
@staticmethod
def ReadArray(array_uptr: ctypes.c_void_p,
valuemapper: Callable[[c_void_p], Any]) -> [[any]]
Reads from unmanaged memory, returning list of any sets (any[][])
WriteArray
Writes an array of any sets (any[][]) into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
ReadNullables
Parameters
array_ptr: c_void_p Pointer to .Net nullable array.
nullable_type: nullable type created by InteropUtils.create_nullable
Returns
[]: array of underlying type with possible None values
ReadLongs
Reads from unmanaged memory, returning list of int64
ReadLongsArray
Reads from unmanaged memory, returning list of int64 lists
WriteLongs
Writes list of int64 into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
WriteLongsArray
Writes list of int64 lists into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
ReadStrings
Reads from unmanaged memory, returning list of str
ReadStringsArray
Reads from unmanaged memory, returning list of str lists
WriteStrings
Writes list of str into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
WriteStringsArray
Writes list of str lists into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
ReadDoubles
Reads from unmanaged memory, returning list of double (float)
ReadDoublesArray
Reads from unmanaged memory, returning list of double (float) lists
WriteDoubles
Writes list of double (float) into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
WriteDoublesArray
Writes list of double (float) lists into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
ReadPointers
Reads from unmanaged memory, returning list of pointers
ReadPointersArray
Reads from unmanaged memory, returning list of pointer lists
WritePointers
Writes list of pointer into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
WritePointersArray
Writes list of pointer lists into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
ReadBytes
Reads from unmanaged memory, returning bytes
ReadBytesArray
Reads from unmanaged memory, returning list of bytes
WriteBytes
Writes list of bytes into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
WriteBytesArray
Writes list of bytes into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
ReadNullableDoubles
Reads from unmanaged memory, returning list of Optional[float]
ReadNullableDoublesArray
Reads from unmanaged memory, returning list of Optional[float] lists
WriteNullableDoubles
Writes list of Optional[float] into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
WriteNullableDoublesArray
@staticmethod
def WriteNullableDoublesArray(
nullable_doubles_array: [[Optional[float]]]) -> c_void_p
Writes list of int64 lists into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length
quixstreams.native.Python.InteropHelpers.ExternalTypes.System.Collection
quixstreams.native.Python.InteropHelpers.ExternalTypes.System.Dictionary
Dictionary Objects
ReadAnyHPtrToUPtr
Read any dictionary that implements IEnumerable<KeyValuePair<,>>. Useful for dictionaries that do not implement
IDictionary, such as ReadOnlyDictionary
Arguments:
dictionary_hptr
: Handler pointer to a dictionary
Returns:
Pointer to array with elements [c_void_p, c_void_p] where first is the key array, 2nd is the value array
WriteBlittables
@staticmethod
def WriteBlittables(dictionary: Dict[any, any], key_converter,
value_converter) -> c_void_p
Writes dictionary into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix
ReadBlittables
Read a pointer into a managed dictionary. The pointer must be to a structure [[keys],[values]], each array with a 4 byte length prefix
WriteStringPointers
Writes dictionary of [str, c_void_p] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix
ReadStringPointers
@staticmethod
def ReadStringPointers(dictionary_uptr: c_void_p,
valuemapper=None) -> Dict[str, c_void_p]
Writes dictionary of [str, c_void_p] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix
WriteStringDoublesArray
Writes dictionary of [str, [float]] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix
ReadStringDoublesArray
Reads unmanaged memory at address, converting it to managed [str, float[]] dictionary
WriteStringLongsArray
Writes dictionary of [str, [int64]] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix
ReadStringLongsArray
Reads unmanaged memory at address, converting it to managed [str, int64p[]] dictionary
WriteStringStrings
Writes dictionary of [str, str] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix
ReadStringStrings
Reads unmanaged memory at address, converting it to managed [str, str] dictionary
WriteStringStringsArray
Writes dictionary of [str, [str]] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix
ReadStringStringsArray
Reads unmanaged memory at address, converting it to managed [str, str[]] dictionary
WriteStringBytesArray
Writes dictionary of [str, [bytes]] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix
ReadStringBytesArray
Reads unmanaged memory at address, converting it to managed [str, [bytes]] dictionary
WriteStringNullableDoublesArray
@staticmethod
def WriteStringNullableDoublesArray(
dictionary: Dict[str, List[Optional[float]]]) -> c_void_p
Writes dictionary of [str, [Optional[float]]] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix
ReadStringNullableDoublesArray
@staticmethod
def ReadStringNullableDoublesArray(
dictionary: Dict[str, List[Optional[Optional[float]]]]) -> c_void_p
Reads unmanaged memory at address, converting it to managed [str, float[]] dictionary
quixstreams.native.Python.InteropHelpers.ExternalTypes.System.Enumerable
Enumerable Objects
ReadAny
Read any object that implements IEnumerable. Useful for cases when other enumerable methods don't fulfill the
the role in a more efficient manner
Arguments:
enumerable_hptr
: Handler pointer to an object
Returns:
Handle pointer to an array of values which depend on the underlying value types
quixstreams.native.Python.InteropHelpers.ExternalTypes.System.List
quixstreams.native.Python.InteropHelpers.InteropUtils
InteropUtils Objects
set_exception_callback
Sets the exception handler for interop exceptions
callback: Callable[[InteropException], None] The callback which takes InteropException and returns nothing
log_debug
Logs debug message if debugging is enabled
message: str The message to log
enable_debug
Enables Debugging logs
disable_debug
Enables Debugging logs
pin_hptr_target
Creates a GC Handle with pinned type. Use get_pin_address to acquire the pinned resources's address Must be freed as soon as possible with free_hptr
Parameters
hptr: c_void_p Pointer to .Net GC Handle
Returns
c_void_p: .Net pointer to the value
get_pin_address
Retrieves the address of the pinned resource from the provided GC Handle ptr
Parameters
hptr: c_void_p Pointer to .Net pinned GC Handle
Returns
c_void_p: memory address of the underlying resource
free_hptr
Frees the provided GC Handle
Parameters
hptr: c_void_p Pointer to .Net GC Handle
free_uptr
Frees the provided unmanaged pointer
Parameters
uptr: c_void_p Unmanaged pointer
allocate_uptr
Allocated unmanaged memory pointer of the desired size
Parameters
size: c_void_p The desired size of the memory
Returns
c_void_p: Unmanaged memory pointer
invoke_and_free
Invokes a function where first positional argument is a c# GC Handle pointer (hptr), then disposes it
Parameters
hptr: ctypes.c_void_p c# GC Handle pointer (hptr)
func: callable function where first arg is the hptr
Returns
Any: the function result
dict_nullables
TODO Should I lock on this?
create_nullable
Create a nullable type that is equivalent for serialization purposes to a nullable c# type in places where it is serialized as a struct. In this case byte prefix is added equivalent to minimum addressable memory size according to cpu architecture. For example a nullable double on 64 bit would be 8 bytes for boolean and 8 bytes for double.
Parameters
underlying_ctype: type defined by ctypes such as ctypes.c_double
dict_mem_nullables
TODO Should I lock on this?
create_mem_nullable
Create a nullable type that is equivalent for serialization purposes to a nullable c# type in places where it is not serialized as a struct, but rather as a continuous memory segment to pointed at by either a pointer or array. In this case 1 byte prefix is added kept for the boolean flag rather than the min addressable memory size according to cpu architecture. For example a nullable double on 64 bit would be 1 byte for boolean and 8 bytes for double.
Parameters
underlying_ctype: type defined by ctypes such as ctypes.c_double
quixstreams.native.Python.MicrosoftExtensionsLoggingAbstractions.Microsoft.Extensions.Logging.LogLevel
quixstreams.native.Python.QuixStreamsState.StateValue
StateValue Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StateValue
Returns
StateValue: Instance wrapping the .net type StateValue
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StateValue
Returns
StateValue: Instance wrapping the .net type StateValue
Constructor
Parameters
value: bool Underlying .Net type is Boolean
Returns
c_void_p: GC Handle Pointer to .Net type StateValue
Constructor2
Parameters
value: int Underlying .Net type is long
Returns
c_void_p: GC Handle Pointer to .Net type StateValue
Constructor3
Parameters
value: c_void_p GC Handle Pointer to .Net type byte[]
Returns
c_void_p: GC Handle Pointer to .Net type StateValue
Constructor4
Parameters
value: c_void_p GC Handle Pointer to .Net type byte[]
type: StateType Underlying .Net type is StateValue.StateType
Returns
c_void_p: GC Handle Pointer to .Net type StateValue
Constructor5
Parameters
value: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type StateValue
Constructor6
Parameters
value: float Underlying .Net type is double
Returns
c_void_p: GC Handle Pointer to .Net type StateValue
get_Type
Parameters
Returns
StateType: Underlying .Net type is StateValue.StateType
get_DoubleValue
Parameters
Returns
float: Underlying .Net type is double
get_LongValue
Parameters
Returns
int: Underlying .Net type is long
get_StringValue
Parameters
Returns
str: Underlying .Net type is string
get_BoolValue
Parameters
Returns
bool: Underlying .Net type is Boolean
get_BinaryValue
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type byte[]
Equals
Parameters
other: c_void_p GC Handle Pointer to .Net type StateValue
Returns
bool: Underlying .Net type is Boolean
quixstreams.native.Python.QuixStreamsState.StateValue_StateType
quixstreams.native.Python.QuixStreamsState.Storage.FileStorage.LocalFileStorage.LocalFileStorage
LocalFileStorage Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type LocalFileStorage
Returns
LocalFileStorage: Instance wrapping the .net type LocalFileStorage
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type LocalFileStorage
Returns
LocalFileStorage: Instance wrapping the .net type LocalFileStorage
Constructor
Parameters
storageDirectory: str (Optional) Underlying .Net type is string. Defaults to None
autoCreateDir: bool (Optional) Underlying .Net type is Boolean. Defaults to True
Returns
c_void_p: GC Handle Pointer to .Net type LocalFileStorage
quixstreams.native.Python.QuixStreamsState.Storage.IStateStorage
IStateStorage Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type IStateStorage
Returns
IStateStorage: Instance wrapping the .net type IStateStorage
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type IStateStorage
Returns
IStateStorage: Instance wrapping the .net type IStateStorage
quixstreams.native.Python.QuixStreamsState.Storage.StorageExtensions
StorageExtensions Objects
Set
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
value: int Underlying .Net type is long
Returns
None: Underlying .Net type is void
Set2
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
value: float Underlying .Net type is double
Returns
None: Underlying .Net type is void
Set3
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
value: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
Set4
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
value: c_void_p GC Handle Pointer to .Net type byte[]
Returns
None: Underlying .Net type is void
Set5
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
value: bool Underlying .Net type is Boolean
Returns
None: Underlying .Net type is void
Set6
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
value: c_void_p GC Handle Pointer to .Net type StateValue
Returns
None: Underlying .Net type is void
Get
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type StateValue
GetDouble
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
Returns
float: Underlying .Net type is double
GetString
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
Returns
str: Underlying .Net type is string
GetBool
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
Returns
bool: Underlying .Net type is Boolean
GetLong
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
Returns
int: Underlying .Net type is long
GetBinary
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type byte[]
Remove
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
ContainsKey
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
key: str Underlying .Net type is string
Returns
bool: Underlying .Net type is Boolean
GetAllKeys
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
Returns
c_void_p: GC Handle Pointer to .Net type string[]
Clear
Parameters
stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.App
App Objects
Run
@staticmethod
def Run(cancellationToken: c_void_p = None,
beforeShutdown: Callable[[], None] = None) -> None
Parameters
cancellationToken: c_void_p (Optional) GC Handle Pointer to .Net type CancellationToken. Defaults to None
beforeShutdown: Callable[[], None] (Optional) Underlying .Net type is Action. Defaults to None
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Configuration.SaslMechanism
quixstreams.native.Python.QuixStreamsStreaming.Configuration.SecurityOptions
SecurityOptions Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type SecurityOptions
Returns
SecurityOptions: Instance wrapping the .net type SecurityOptions
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type SecurityOptions
Returns
SecurityOptions: Instance wrapping the .net type SecurityOptions
Constructor
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type SecurityOptions
Constructor2
@staticmethod
def Constructor2(
sslCertificates: str,
username: str,
password: str,
saslMechanism: SaslMechanism = SaslMechanism.ScramSha256) -> c_void_p
Parameters
sslCertificates: str Underlying .Net type is string
username: str Underlying .Net type is string
password: str Underlying .Net type is string
saslMechanism: SaslMechanism (Optional) Underlying .Net type is SaslMechanism. Defaults to ScramSha256
Returns
c_void_p: GC Handle Pointer to .Net type SecurityOptions
get_SaslMechanism
Parameters
Returns
Optional[SaslMechanism]: Underlying .Net type is SaslMechanism?
set_SaslMechanism
Parameters
value: Optional[SaslMechanism] Underlying .Net type is SaslMechanism?
Returns
None: Underlying .Net type is void
get_Username
Parameters
Returns
str: Underlying .Net type is string
set_Username
Parameters
value: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
get_Password
Parameters
Returns
str: Underlying .Net type is string
set_Password
Parameters
value: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
get_SslCertificates
Parameters
Returns
str: Underlying .Net type is string
set_SslCertificates
Parameters
value: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
get_UseSsl
Parameters
Returns
bool: Underlying .Net type is Boolean
set_UseSsl
Parameters
value: bool Underlying .Net type is Boolean
Returns
None: Underlying .Net type is void
get_UseSasl
Parameters
Returns
bool: Underlying .Net type is Boolean
set_UseSasl
Parameters
value: bool Underlying .Net type is Boolean
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.IStreamConsumer
IStreamConsumer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type IStreamConsumer
Returns
IStreamConsumer: Instance wrapping the .net type IStreamConsumer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type IStreamConsumer
Returns
IStreamConsumer: Instance wrapping the .net type IStreamConsumer
get_StreamId
Parameters
Returns
str: Underlying .Net type is string
get_Properties
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type StreamPropertiesConsumer
get_Timeseries
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type StreamTimeseriesConsumer
get_Events
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type StreamEventsConsumer
add_OnPackageReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnPackageReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
add_OnStreamClosed
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnStreamClosed
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.IStreamProducer
IStreamProducer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type IStreamProducer
Returns
IStreamProducer: Instance wrapping the .net type IStreamProducer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type IStreamProducer
Returns
IStreamProducer: Instance wrapping the .net type IStreamProducer
get_StreamId
Parameters
Returns
str: Underlying .Net type is string
get_Epoch
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type DateTime
set_Epoch
Parameters
value: c_void_p GC Handle Pointer to .Net type DateTime
Returns
None: Underlying .Net type is void
get_Properties
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type StreamPropertiesProducer
get_Timeseries
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type StreamTimeseriesProducer
get_Events
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type StreamEventsProducer
Flush
Parameters
Returns
None: Underlying .Net type is void
Close
Parameters
streamState: StreamEndType (Optional) Underlying .Net type is StreamEndType. Defaults to Closed
Returns
None: Underlying .Net type is void
add_OnWriteException
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnWriteException
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.ITopicConsumer
ITopicConsumer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type ITopicConsumer
Returns
ITopicConsumer: Instance wrapping the .net type ITopicConsumer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type ITopicConsumer
Returns
ITopicConsumer: Instance wrapping the .net type ITopicConsumer
Subscribe
Parameters
Returns
None: Underlying .Net type is void
add_OnStreamReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnStreamReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
add_OnRevoking
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnRevoking
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
add_OnStreamsRevoked
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnStreamsRevoked
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
add_OnCommitted
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnCommitted
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
add_OnCommitting
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnCommitting
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
Commit
Parameters
Returns
None: Underlying .Net type is void
add_OnDisposed
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnDisposed
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.ITopicProducer
ITopicProducer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type ITopicProducer
Returns
ITopicProducer: Instance wrapping the .net type ITopicProducer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type ITopicProducer
Returns
ITopicProducer: Instance wrapping the .net type ITopicProducer
CreateStream
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type IStreamProducer
CreateStream2
Parameters
streamId: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type IStreamProducer
GetStream
Parameters
streamId: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type IStreamProducer
GetOrCreateStream
def GetOrCreateStream(
streamId: str,
onStreamCreated: Callable[[c_void_p], None] = None) -> c_void_p
Parameters
streamId: str Underlying .Net type is string
onStreamCreated: Callable[[c_void_p], None]
(Optional) Underlying .Net type is Action
Returns
c_void_p: GC Handle Pointer to .Net type IStreamProducer
add_OnDisposed
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnDisposed
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.KafkaStreamingClient
KafkaStreamingClient Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type KafkaStreamingClient
Returns
KafkaStreamingClient: Instance wrapping the .net type KafkaStreamingClient
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type KafkaStreamingClient
Returns
KafkaStreamingClient: Instance wrapping the .net type KafkaStreamingClient
Constructor
@staticmethod
def Constructor(brokerAddress: str,
securityOptions: c_void_p = None,
properties: c_void_p = None,
debug: bool = False) -> c_void_p
Parameters
brokerAddress: str Underlying .Net type is string
securityOptions: c_void_p (Optional) GC Handle Pointer to .Net type SecurityOptions. Defaults to None
properties: c_void_p
(Optional) GC Handle Pointer to .Net type IDictionary
debug: bool (Optional) Underlying .Net type is Boolean. Defaults to False
Returns
c_void_p: GC Handle Pointer to .Net type KafkaStreamingClient
GetTopicConsumer
def GetTopicConsumer(
topic: str,
consumerGroup: str = None,
options: c_void_p = None,
autoOffset: AutoOffsetReset = AutoOffsetReset.Latest) -> c_void_p
Parameters
topic: str Underlying .Net type is string
consumerGroup: str (Optional) Underlying .Net type is string. Defaults to None
options: c_void_p (Optional) GC Handle Pointer to .Net type CommitOptions. Defaults to None
autoOffset: AutoOffsetReset (Optional) Underlying .Net type is AutoOffsetReset. Defaults to Latest
Returns
c_void_p: GC Handle Pointer to .Net type ITopicConsumer
GetRawTopicConsumer
def GetRawTopicConsumer(
topic: str,
consumerGroup: str = None,
autoOffset: Optional[AutoOffsetReset] = None) -> c_void_p
Parameters
topic: str Underlying .Net type is string
consumerGroup: str (Optional) Underlying .Net type is string. Defaults to None
autoOffset: Optional[AutoOffsetReset] (Optional) Underlying .Net type is AutoOffsetReset?. Defaults to None
Returns
c_void_p: GC Handle Pointer to .Net type IRawTopicConsumer
GetRawTopicProducer
Parameters
topic: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type IRawTopicProducer
GetTopicProducer
Parameters
topic: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type ITopicProducer
quixstreams.native.Python.QuixStreamsStreaming.KafkaStreamingClientExtensions
KafkaStreamingClientExtensions Objects
GetTopicConsumer
@staticmethod
def GetTopicConsumer(
client: c_void_p,
topic: str,
consumerGroup: str = None,
commitMode: CommitMode = CommitMode.Automatic,
autoOffset: AutoOffsetReset = AutoOffsetReset.Latest) -> c_void_p
Parameters
client: c_void_p GC Handle Pointer to .Net type KafkaStreamingClient
topic: str Underlying .Net type is string
consumerGroup: str (Optional) Underlying .Net type is string. Defaults to None
commitMode: CommitMode (Optional) Underlying .Net type is CommitMode. Defaults to Automatic
autoOffset: AutoOffsetReset (Optional) Underlying .Net type is AutoOffsetReset. Defaults to Latest
Returns
c_void_p: GC Handle Pointer to .Net type ITopicConsumer
quixstreams.native.Python.QuixStreamsStreaming.Models.CommitMode
quixstreams.native.Python.QuixStreamsStreaming.Models.EventData
EventData Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type EventData
Returns
EventData: Instance wrapping the .net type EventData
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type EventData
Returns
EventData: Instance wrapping the .net type EventData
Constructor
Parameters
eventId: str Underlying .Net type is string
timestampNanoseconds: int Underlying .Net type is long
eventValue: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type EventData
Constructor2
Parameters
eventId: str Underlying .Net type is string
timestamp: c_void_p GC Handle Pointer to .Net type DateTime
eventValue: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type EventData
Constructor3
Parameters
eventId: str Underlying .Net type is string
timestamp: c_void_p GC Handle Pointer to .Net type TimeSpan
eventValue: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type EventData
Clone
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type EventData
get_Id
Parameters
Returns
str: Underlying .Net type is string
set_Id
Parameters
value: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
get_Value
Parameters
Returns
str: Underlying .Net type is string
set_Value
Parameters
value: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
get_Tags
Parameters
Returns
c_void_p:
GC Handle Pointer to .Net type IDictionary
AddTag
Parameters
tagId: str Underlying .Net type is string
tagValue: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type EventData
AddTags
Parameters
tags: c_void_p
GC Handle Pointer to .Net type IEnumerable
Returns
c_void_p: GC Handle Pointer to .Net type EventData
RemoveTag
Parameters
tagId: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type EventData
get_TimestampNanoseconds
Parameters
Returns
int: Underlying .Net type is long
get_TimestampMilliseconds
Parameters
Returns
int: Underlying .Net type is long
get_Timestamp
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type DateTime
get_TimestampAsTimeSpan
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type TimeSpan
quixstreams.native.Python.QuixStreamsStreaming.Models.EventDefinition
EventDefinition Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type EventDefinition
Returns
EventDefinition: Instance wrapping the .net type EventDefinition
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type EventDefinition
Returns
EventDefinition: Instance wrapping the .net type EventDefinition
Constructor
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type EventDefinition
get_Id
Parameters
Returns
str: Underlying .Net type is string
get_Name
Parameters
Returns
str: Underlying .Net type is string
get_Description
Parameters
Returns
str: Underlying .Net type is string
get_Location
Parameters
Returns
str: Underlying .Net type is string
get_CustomProperties
Parameters
Returns
str: Underlying .Net type is string
get_Level
Parameters
Returns
EventLevel: Underlying .Net type is EventLevel
quixstreams.native.Python.QuixStreamsStreaming.Models.ParameterDefinition
ParameterDefinition Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type ParameterDefinition
Returns
ParameterDefinition: Instance wrapping the .net type ParameterDefinition
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type ParameterDefinition
Returns
ParameterDefinition: Instance wrapping the .net type ParameterDefinition
Constructor
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type ParameterDefinition
get_Id
Parameters
Returns
str: Underlying .Net type is string
get_Name
Parameters
Returns
str: Underlying .Net type is string
get_Description
Parameters
Returns
str: Underlying .Net type is string
get_Location
Parameters
Returns
str: Underlying .Net type is string
get_MinimumValue
Parameters
Returns
Optional[float]: Underlying .Net type is double?
get_MaximumValue
Parameters
Returns
Optional[float]: Underlying .Net type is double?
get_Unit
Parameters
Returns
str: Underlying .Net type is string
get_Format
Parameters
Returns
str: Underlying .Net type is string
get_CustomProperties
Parameters
Returns
str: Underlying .Net type is string
quixstreams.native.Python.QuixStreamsStreaming.Models.ParameterValue
ParameterValue Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type ParameterValue
Returns
ParameterValue: Instance wrapping the .net type ParameterValue
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type ParameterValue
Returns
ParameterValue: Instance wrapping the .net type ParameterValue
get_ParameterId
Parameters
Returns
str: Underlying .Net type is string
get_NumericValue
Parameters
Returns
Optional[float]: Underlying .Net type is double?
set_NumericValue
Parameters
value: Optional[float] Underlying .Net type is double?
Returns
None: Underlying .Net type is void
get_StringValue
Parameters
Returns
str: Underlying .Net type is string
set_StringValue
Parameters
value: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
get_BinaryValue
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type byte[]
set_BinaryValue
Parameters
value: c_void_p GC Handle Pointer to .Net type byte[]
Returns
None: Underlying .Net type is void
get_Value
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type Object
op_Equality
Parameters
lhs: c_void_p GC Handle Pointer to .Net type ParameterValue
rhs: c_void_p GC Handle Pointer to .Net type ParameterValue
Returns
bool: Underlying .Net type is Boolean
op_Inequality
Parameters
lhs: c_void_p GC Handle Pointer to .Net type ParameterValue
rhs: c_void_p GC Handle Pointer to .Net type ParameterValue
Returns
bool: Underlying .Net type is Boolean
Equals
Parameters
obj: c_void_p GC Handle Pointer to .Net type Object
Returns
bool: Underlying .Net type is Boolean
GetHashCode
Parameters
Returns
int: Underlying .Net type is int
ToString
Parameters
Returns
str: Underlying .Net type is string
get_Type
Parameters
Returns
ParameterValueType: Underlying .Net type is ParameterValueType
quixstreams.native.Python.QuixStreamsStreaming.Models.ParameterValueType
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.EventDataReadEventArgs
EventDataReadEventArgs Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type EventDataReadEventArgs
Returns
EventDataReadEventArgs: Instance wrapping the .net type EventDataReadEventArgs
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type EventDataReadEventArgs
Returns
EventDataReadEventArgs: Instance wrapping the .net type EventDataReadEventArgs
Constructor
@staticmethod
def Constructor(topicConsumer: c_void_p, consumer: c_void_p,
data: c_void_p) -> c_void_p
Parameters
topicConsumer: c_void_p GC Handle Pointer to .Net type ITopicConsumer
consumer: c_void_p GC Handle Pointer to .Net type IStreamConsumer
data: c_void_p GC Handle Pointer to .Net type EventData
Returns
c_void_p: GC Handle Pointer to .Net type EventDataReadEventArgs
get_TopicConsumer
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type ITopicConsumer
get_Stream
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type IStreamConsumer
get_Data
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type EventData
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.EventDefinitionsChangedEventArgs
EventDefinitionsChangedEventArgs Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type EventDefinitionsChangedEventArgs
Returns
EventDefinitionsChangedEventArgs: Instance wrapping the .net type EventDefinitionsChangedEventArgs
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type EventDefinitionsChangedEventArgs
Returns
EventDefinitionsChangedEventArgs: Instance wrapping the .net type EventDefinitionsChangedEventArgs
Constructor
Parameters
topicConsumer: c_void_p GC Handle Pointer to .Net type ITopicConsumer
consumer: c_void_p GC Handle Pointer to .Net type IStreamConsumer
Returns
c_void_p: GC Handle Pointer to .Net type EventDefinitionsChangedEventArgs
get_TopicConsumer
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type ITopicConsumer
get_Stream
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type IStreamConsumer
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.ParameterDefinitionsChangedEventArgs
ParameterDefinitionsChangedEventArgs Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type ParameterDefinitionsChangedEventArgs
Returns
ParameterDefinitionsChangedEventArgs: Instance wrapping the .net type ParameterDefinitionsChangedEventArgs
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type ParameterDefinitionsChangedEventArgs
Returns
ParameterDefinitionsChangedEventArgs: Instance wrapping the .net type ParameterDefinitionsChangedEventArgs
Constructor
Parameters
topicConsumer: c_void_p GC Handle Pointer to .Net type ITopicConsumer
consumer: c_void_p GC Handle Pointer to .Net type IStreamConsumer
Returns
c_void_p: GC Handle Pointer to .Net type ParameterDefinitionsChangedEventArgs
get_TopicConsumer
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type ITopicConsumer
get_Stream
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type IStreamConsumer
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.StreamEventsConsumer
StreamEventsConsumer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamEventsConsumer
Returns
StreamEventsConsumer: Instance wrapping the .net type StreamEventsConsumer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamEventsConsumer
Returns
StreamEventsConsumer: Instance wrapping the .net type StreamEventsConsumer
add_OnDataReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnDataReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
add_OnDefinitionsChanged
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnDefinitionsChanged
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
get_Definitions
Parameters
Returns
c_void_p:
GC Handle Pointer to .Net type IList
Dispose
Parameters
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.StreamPropertiesChangedEventArgs
StreamPropertiesChangedEventArgs Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamPropertiesChangedEventArgs
Returns
StreamPropertiesChangedEventArgs: Instance wrapping the .net type StreamPropertiesChangedEventArgs
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamPropertiesChangedEventArgs
Returns
StreamPropertiesChangedEventArgs: Instance wrapping the .net type StreamPropertiesChangedEventArgs
Constructor
Parameters
topicConsumer: c_void_p GC Handle Pointer to .Net type ITopicConsumer
consumer: c_void_p GC Handle Pointer to .Net type IStreamConsumer
Returns
c_void_p: GC Handle Pointer to .Net type StreamPropertiesChangedEventArgs
get_TopicConsumer
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type ITopicConsumer
get_Stream
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type IStreamConsumer
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.StreamPropertiesConsumer
StreamPropertiesConsumer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamPropertiesConsumer
Returns
StreamPropertiesConsumer: Instance wrapping the .net type StreamPropertiesConsumer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamPropertiesConsumer
Returns
StreamPropertiesConsumer: Instance wrapping the .net type StreamPropertiesConsumer
add_OnChanged
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnChanged
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
get_Name
Parameters
Returns
str: Underlying .Net type is string
get_Location
Parameters
Returns
str: Underlying .Net type is string
get_TimeOfRecording
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type DateTime?
get_Metadata
Parameters
Returns
c_void_p:
GC Handle Pointer to .Net type Dictionary
get_Parents
Parameters
Returns
c_void_p:
GC Handle Pointer to .Net type List
Dispose
Parameters
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.StreamTimeseriesConsumer
StreamTimeseriesConsumer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamTimeseriesConsumer
Returns
StreamTimeseriesConsumer: Instance wrapping the .net type StreamTimeseriesConsumer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamTimeseriesConsumer
Returns
StreamTimeseriesConsumer: Instance wrapping the .net type StreamTimeseriesConsumer
CreateBuffer
Parameters
parametersFilter: c_void_p GC Handle Pointer to .Net type string[]
bufferConfiguration: c_void_p (Optional) GC Handle Pointer to .Net type TimeseriesBufferConfiguration. Defaults to None
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesBufferConsumer
CreateBuffer2
Parameters
parametersFilter: c_void_p GC Handle Pointer to .Net type string[]
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesBufferConsumer
add_OnDefinitionsChanged
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnDefinitionsChanged
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
add_OnDataReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnDataReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
add_OnRawReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnRawReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
get_Definitions
Parameters
Returns
c_void_p:
GC Handle Pointer to .Net type List
Dispose
Parameters
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.TimeseriesBufferConsumer
TimeseriesBufferConsumer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferConsumer
Returns
TimeseriesBufferConsumer: Instance wrapping the .net type TimeseriesBufferConsumer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferConsumer
Returns
TimeseriesBufferConsumer: Instance wrapping the .net type TimeseriesBufferConsumer
Dispose
Parameters
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.TimeseriesDataRawReadEventArgs
TimeseriesDataRawReadEventArgs Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataRawReadEventArgs
Returns
TimeseriesDataRawReadEventArgs: Instance wrapping the .net type TimeseriesDataRawReadEventArgs
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataRawReadEventArgs
Returns
TimeseriesDataRawReadEventArgs: Instance wrapping the .net type TimeseriesDataRawReadEventArgs
Constructor
Parameters
topic: c_void_p GC Handle Pointer to .Net type Object
stream: c_void_p GC Handle Pointer to .Net type Object
data: c_void_p GC Handle Pointer to .Net type TimeseriesDataRaw
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataRawReadEventArgs
get_Topic
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type Object
get_Stream
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type Object
get_Data
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataRaw
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.TimeseriesDataReadEventArgs
TimeseriesDataReadEventArgs Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataReadEventArgs
Returns
TimeseriesDataReadEventArgs: Instance wrapping the .net type TimeseriesDataReadEventArgs
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataReadEventArgs
Returns
TimeseriesDataReadEventArgs: Instance wrapping the .net type TimeseriesDataReadEventArgs
Constructor
Parameters
topic: c_void_p GC Handle Pointer to .Net type Object
stream: c_void_p GC Handle Pointer to .Net type Object
data: c_void_p GC Handle Pointer to .Net type TimeseriesData
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataReadEventArgs
get_Topic
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type Object
get_Stream
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type Object
get_Data
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesData
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.EventDataBuilder
EventDataBuilder Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type EventDataBuilder
Returns
EventDataBuilder: Instance wrapping the .net type EventDataBuilder
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type EventDataBuilder
Returns
EventDataBuilder: Instance wrapping the .net type EventDataBuilder
Constructor
@staticmethod
def Constructor(streamEventsProducer: c_void_p,
timestampNanoseconds: int) -> c_void_p
Parameters
streamEventsProducer: c_void_p GC Handle Pointer to .Net type StreamEventsProducer
timestampNanoseconds: int Underlying .Net type is long
Returns
c_void_p: GC Handle Pointer to .Net type EventDataBuilder
AddValue
Parameters
eventId: str Underlying .Net type is string
value: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type EventDataBuilder
AddTag
Parameters
tagId: str Underlying .Net type is string
value: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type EventDataBuilder
AddTags
Parameters
tagsValues: c_void_p
GC Handle Pointer to .Net type IEnumerable
Returns
c_void_p: GC Handle Pointer to .Net type EventDataBuilder
Publish
Parameters
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.EventDefinitionBuilder
EventDefinitionBuilder Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type EventDefinitionBuilder
Returns
EventDefinitionBuilder: Instance wrapping the .net type EventDefinitionBuilder
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type EventDefinitionBuilder
Returns
EventDefinitionBuilder: Instance wrapping the .net type EventDefinitionBuilder
Constructor
@staticmethod
def Constructor(streamEventsProducer: c_void_p,
location: str,
properties: c_void_p = None) -> c_void_p
Parameters
streamEventsProducer: c_void_p GC Handle Pointer to .Net type StreamEventsProducer
location: str Underlying .Net type is string
properties: c_void_p (Optional) GC Handle Pointer to .Net type EventDefinition. Defaults to None
Returns
c_void_p: GC Handle Pointer to .Net type EventDefinitionBuilder
SetLevel
Parameters
level: EventLevel Underlying .Net type is EventLevel
Returns
c_void_p: GC Handle Pointer to .Net type EventDefinitionBuilder
SetCustomProperties
Parameters
customProperties: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type EventDefinitionBuilder
AddDefinition
Parameters
eventId: str Underlying .Net type is string
name: str (Optional) Underlying .Net type is string. Defaults to None
description: str (Optional) Underlying .Net type is string. Defaults to None
Returns
c_void_p: GC Handle Pointer to .Net type EventDefinitionBuilder
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.ParameterDefinitionBuilder
ParameterDefinitionBuilder Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type ParameterDefinitionBuilder
Returns
ParameterDefinitionBuilder: Instance wrapping the .net type ParameterDefinitionBuilder
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type ParameterDefinitionBuilder
Returns
ParameterDefinitionBuilder: Instance wrapping the .net type ParameterDefinitionBuilder
Constructor
@staticmethod
def Constructor(streamTimeseriesProducer: c_void_p,
location: str,
definition: c_void_p = None) -> c_void_p
Parameters
streamTimeseriesProducer: c_void_p GC Handle Pointer to .Net type StreamTimeseriesProducer
location: str Underlying .Net type is string
definition: c_void_p (Optional) GC Handle Pointer to .Net type ParameterDefinition. Defaults to None
Returns
c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder
SetRange
Parameters
minimumValue: float Underlying .Net type is double
maximumValue: float Underlying .Net type is double
Returns
c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder
SetUnit
Parameters
unit: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder
SetFormat
Parameters
format: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder
SetCustomProperties
Parameters
customProperties: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder
AddDefinition
Parameters
parameterId: str Underlying .Net type is string
name: str (Optional) Underlying .Net type is string. Defaults to None
description: str (Optional) Underlying .Net type is string. Defaults to None
Returns
c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.StreamEventsProducer
StreamEventsProducer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamEventsProducer
Returns
StreamEventsProducer: Instance wrapping the .net type StreamEventsProducer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamEventsProducer
Returns
StreamEventsProducer: Instance wrapping the .net type StreamEventsProducer
get_DefaultTags
Parameters
Returns
c_void_p:
GC Handle Pointer to .Net type Dictionary
set_DefaultTags
Parameters
value: c_void_p
GC Handle Pointer to .Net type Dictionary
Returns
None: Underlying .Net type is void
get_DefaultLocation
Parameters
Returns
str: Underlying .Net type is string
set_DefaultLocation
Parameters
value: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
get_Epoch
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type DateTime
set_Epoch
Parameters
value: c_void_p GC Handle Pointer to .Net type DateTime
Returns
None: Underlying .Net type is void
AddTimestamp
Parameters
dateTime: c_void_p GC Handle Pointer to .Net type DateTime
Returns
c_void_p: GC Handle Pointer to .Net type EventDataBuilder
AddTimestamp2
Parameters
timeSpan: c_void_p GC Handle Pointer to .Net type TimeSpan
Returns
c_void_p: GC Handle Pointer to .Net type EventDataBuilder
AddTimestampMilliseconds
Parameters
timeMilliseconds: int Underlying .Net type is long
Returns
c_void_p: GC Handle Pointer to .Net type EventDataBuilder
AddTimestampNanoseconds
Parameters
timeNanoseconds: int Underlying .Net type is long
Returns
c_void_p: GC Handle Pointer to .Net type EventDataBuilder
AddDefinitions
Parameters
definitions: c_void_p
GC Handle Pointer to .Net type List
Returns
None: Underlying .Net type is void
AddDefinition
Parameters
eventId: str Underlying .Net type is string
name: str (Optional) Underlying .Net type is string. Defaults to None
description: str (Optional) Underlying .Net type is string. Defaults to None
Returns
c_void_p: GC Handle Pointer to .Net type EventDefinitionBuilder
AddLocation
Parameters
location: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type EventDefinitionBuilder
Flush
Parameters
Returns
None: Underlying .Net type is void
Publish
Parameters
data: c_void_p GC Handle Pointer to .Net type EventData
Returns
None: Underlying .Net type is void
Publish2
Parameters
events: c_void_p
GC Handle Pointer to .Net type ICollection
Returns
None: Underlying .Net type is void
Dispose
Parameters
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.StreamPropertiesProducer
StreamPropertiesProducer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamPropertiesProducer
Returns
StreamPropertiesProducer: Instance wrapping the .net type StreamPropertiesProducer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamPropertiesProducer
Returns
StreamPropertiesProducer: Instance wrapping the .net type StreamPropertiesProducer
get_FlushInterval
Parameters
Returns
int: Underlying .Net type is int
set_FlushInterval
Parameters
value: int Underlying .Net type is int
Returns
None: Underlying .Net type is void
get_Name
Parameters
Returns
str: Underlying .Net type is string
set_Name
Parameters
value: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
get_Location
Parameters
Returns
str: Underlying .Net type is string
set_Location
Parameters
value: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
get_TimeOfRecording
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type DateTime?
set_TimeOfRecording
Parameters
value: c_void_p GC Handle Pointer to .Net type DateTime?
Returns
None: Underlying .Net type is void
get_Metadata
Parameters
Returns
c_void_p:
GC Handle Pointer to .Net type ObservableDictionary
get_Parents
Parameters
Returns
c_void_p:
GC Handle Pointer to .Net type ObservableCollection
AddParent
Parameters
parentStreamId: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
RemoveParent
Parameters
parentStreamId: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
Flush
Parameters
Returns
None: Underlying .Net type is void
Dispose
Parameters
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.StreamTimeseriesProducer
StreamTimeseriesProducer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamTimeseriesProducer
Returns
StreamTimeseriesProducer: Instance wrapping the .net type StreamTimeseriesProducer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type StreamTimeseriesProducer
Returns
StreamTimeseriesProducer: Instance wrapping the .net type StreamTimeseriesProducer
get_Buffer
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesBufferProducer
Publish
Parameters
data: c_void_p GC Handle Pointer to .Net type TimeseriesData
Returns
None: Underlying .Net type is void
Publish2
Parameters
data: c_void_p GC Handle Pointer to .Net type TimeseriesDataRaw
Returns
None: Underlying .Net type is void
get_DefaultLocation
Parameters
Returns
str: Underlying .Net type is string
set_DefaultLocation
Parameters
value: str Underlying .Net type is string
Returns
None: Underlying .Net type is void
AddDefinitions
Parameters
definitions: c_void_p
GC Handle Pointer to .Net type List
Returns
None: Underlying .Net type is void
AddDefinition
Parameters
parameterId: str Underlying .Net type is string
name: str (Optional) Underlying .Net type is string. Defaults to None
description: str (Optional) Underlying .Net type is string. Defaults to None
Returns
c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder
AddLocation
Parameters
location: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder
Flush
Parameters
Returns
None: Underlying .Net type is void
Dispose
Parameters
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.TimeseriesBufferProducer
TimeseriesBufferProducer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferProducer
Returns
TimeseriesBufferProducer: Instance wrapping the .net type TimeseriesBufferProducer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferProducer
Returns
TimeseriesBufferProducer: Instance wrapping the .net type TimeseriesBufferProducer
get_Epoch
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type DateTime
set_Epoch
Parameters
value: c_void_p GC Handle Pointer to .Net type DateTime
Returns
None: Underlying .Net type is void
AddTimestamp
Parameters
dateTime: c_void_p GC Handle Pointer to .Net type DateTime
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder
AddTimestamp2
Parameters
timeSpan: c_void_p GC Handle Pointer to .Net type TimeSpan
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder
AddTimestampMilliseconds
Parameters
timeMilliseconds: int Underlying .Net type is long
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder
AddTimestampNanoseconds
Parameters
timeNanoseconds: int Underlying .Net type is long
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder
Publish
Parameters
data: c_void_p GC Handle Pointer to .Net type TimeseriesData
Returns
None: Underlying .Net type is void
get_DefaultTags
Parameters
Returns
c_void_p:
GC Handle Pointer to .Net type Dictionary
set_DefaultTags
Parameters
value: c_void_p
GC Handle Pointer to .Net type Dictionary
Returns
None: Underlying .Net type is void
Flush
Parameters
Returns
None: Underlying .Net type is void
Dispose
Parameters
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.TimeseriesDataBuilder
TimeseriesDataBuilder Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataBuilder
Returns
TimeseriesDataBuilder: Instance wrapping the .net type TimeseriesDataBuilder
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataBuilder
Returns
TimeseriesDataBuilder: Instance wrapping the .net type TimeseriesDataBuilder
Constructor
Parameters
buffer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferProducer
data: c_void_p GC Handle Pointer to .Net type TimeseriesData
timestamp: c_void_p GC Handle Pointer to .Net type TimeseriesDataTimestamp
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder
AddValue
Parameters
parameterId: str Underlying .Net type is string
value: float Underlying .Net type is double
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder
AddValue2
Parameters
parameterId: str Underlying .Net type is string
value: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder
AddValue3
Parameters
parameterId: str Underlying .Net type is string
value: c_void_p GC Handle Pointer to .Net type byte[]
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder
AddTag
Parameters
tagId: str Underlying .Net type is string
value: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder
AddTags
Parameters
tags: c_void_p
GC Handle Pointer to .Net type IEnumerable
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder
Publish
Parameters
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Models.TimeseriesBuffer
TimeseriesBuffer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBuffer
Returns
TimeseriesBuffer: Instance wrapping the .net type TimeseriesBuffer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBuffer
Returns
TimeseriesBuffer: Instance wrapping the .net type TimeseriesBuffer
add_OnDataReleased
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnDataReleased
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
add_OnRawReleased
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnRawReleased
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
get_PacketSize
Parameters
Returns
Optional[int]: Underlying .Net type is int?
set_PacketSize
Parameters
value: Optional[int] Underlying .Net type is int?
Returns
None: Underlying .Net type is void
get_BufferTimeout
Parameters
Returns
Optional[int]: Underlying .Net type is int?
set_BufferTimeout
Parameters
value: Optional[int] Underlying .Net type is int?
Returns
None: Underlying .Net type is void
get_TimeSpanInNanoseconds
Parameters
Returns
Optional[int]: Underlying .Net type is long?
set_TimeSpanInNanoseconds
Parameters
value: Optional[int] Underlying .Net type is long?
Returns
None: Underlying .Net type is void
get_TimeSpanInMilliseconds
Parameters
Returns
Optional[int]: Underlying .Net type is long?
set_TimeSpanInMilliseconds
Parameters
value: Optional[int] Underlying .Net type is long?
Returns
None: Underlying .Net type is void
get_Filter
Parameters
Returns
Callable[[c_void_p], bool]:
Underlying .Net type is Func
set_Filter
Parameters
value: Callable[[c_void_p], bool]
Underlying .Net type is Func
Returns
None: Underlying .Net type is void
get_CustomTriggerBeforeEnqueue
Parameters
Returns
Callable[[c_void_p], bool]:
Underlying .Net type is Func
set_CustomTriggerBeforeEnqueue
Parameters
value: Callable[[c_void_p], bool]
Underlying .Net type is Func
Returns
None: Underlying .Net type is void
get_CustomTrigger
Parameters
Returns
Callable[[c_void_p], bool]:
Underlying .Net type is Func
set_CustomTrigger
Parameters
value: Callable[[c_void_p], bool]
Underlying .Net type is Func
Returns
None: Underlying .Net type is void
Dispose
Parameters
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Models.TimeseriesBufferConfiguration
TimeseriesBufferConfiguration Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferConfiguration
Returns
TimeseriesBufferConfiguration: Instance wrapping the .net type TimeseriesBufferConfiguration
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferConfiguration
Returns
TimeseriesBufferConfiguration: Instance wrapping the .net type TimeseriesBufferConfiguration
Constructor
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesBufferConfiguration
get_PacketSize
Parameters
Returns
Optional[int]: Underlying .Net type is int?
set_PacketSize
Parameters
value: Optional[int] Underlying .Net type is int?
Returns
None: Underlying .Net type is void
get_TimeSpanInNanoseconds
Parameters
Returns
Optional[int]: Underlying .Net type is long?
set_TimeSpanInNanoseconds
Parameters
value: Optional[int] Underlying .Net type is long?
Returns
None: Underlying .Net type is void
get_TimeSpanInMilliseconds
Parameters
Returns
Optional[int]: Underlying .Net type is long?
set_TimeSpanInMilliseconds
Parameters
value: Optional[int] Underlying .Net type is long?
Returns
None: Underlying .Net type is void
get_CustomTriggerBeforeEnqueue
Parameters
Returns
Callable[[c_void_p], bool]:
Underlying .Net type is Func
set_CustomTriggerBeforeEnqueue
Parameters
value: Callable[[c_void_p], bool]
Underlying .Net type is Func
Returns
None: Underlying .Net type is void
get_CustomTrigger
Parameters
Returns
Callable[[c_void_p], bool]:
Underlying .Net type is Func
set_CustomTrigger
Parameters
value: Callable[[c_void_p], bool]
Underlying .Net type is Func
Returns
None: Underlying .Net type is void
get_Filter
Parameters
Returns
Callable[[c_void_p], bool]:
Underlying .Net type is Func
set_Filter
Parameters
value: Callable[[c_void_p], bool]
Underlying .Net type is Func
Returns
None: Underlying .Net type is void
get_BufferTimeout
Parameters
Returns
Optional[int]: Underlying .Net type is int?
set_BufferTimeout
Parameters
value: Optional[int] Underlying .Net type is int?
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Models.TimeseriesData
TimeseriesData Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesData
Returns
TimeseriesData: Instance wrapping the .net type TimeseriesData
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesData
Returns
TimeseriesData: Instance wrapping the .net type TimeseriesData
Constructor
Parameters
capacity: int (Optional) Underlying .Net type is int. Defaults to 10
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesData
Constructor2
@staticmethod
def Constructor2(rawData: c_void_p,
parametersFilter: c_void_p = None,
merge: bool = True,
clean: bool = True) -> c_void_p
Parameters
rawData: c_void_p GC Handle Pointer to .Net type TimeseriesDataRaw
parametersFilter: c_void_p (Optional) GC Handle Pointer to .Net type string[]. Defaults to None
merge: bool (Optional) Underlying .Net type is Boolean. Defaults to True
clean: bool (Optional) Underlying .Net type is Boolean. Defaults to True
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesData
Constructor3
@staticmethod
def Constructor3(timestamps: c_void_p,
merge: bool = True,
clean: bool = True) -> c_void_p
Parameters
timestamps: c_void_p
GC Handle Pointer to .Net type List
merge: bool (Optional) Underlying .Net type is Boolean. Defaults to True
clean: bool (Optional) Underlying .Net type is Boolean. Defaults to True
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesData
Clone
Parameters
parametersFilter: c_void_p GC Handle Pointer to .Net type string[]
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesData
get_Timestamps
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamps
AddTimestamp
Parameters
dateTime: c_void_p GC Handle Pointer to .Net type DateTime
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp
AddTimestamp2
Parameters
timeSpan: c_void_p GC Handle Pointer to .Net type TimeSpan
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp
AddTimestampMilliseconds
Parameters
timeMilliseconds: int Underlying .Net type is long
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp
AddTimestampNanoseconds
Parameters
timeNanoseconds: int Underlying .Net type is long
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp
Equals
Parameters
obj: c_void_p GC Handle Pointer to .Net type Object
Returns
bool: Underlying .Net type is Boolean
GetHashCode
Parameters
Returns
int: Underlying .Net type is int
quixstreams.native.Python.QuixStreamsStreaming.Models.TimeseriesDataTimestamp
TimeseriesDataTimestamp Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataTimestamp
Returns
TimeseriesDataTimestamp: Instance wrapping the .net type TimeseriesDataTimestamp
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataTimestamp
Returns
TimeseriesDataTimestamp: Instance wrapping the .net type TimeseriesDataTimestamp
get_Parameters
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestampValues
get_Tags
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestampTags
get_TimestampNanoseconds
Parameters
Returns
int: Underlying .Net type is long
set_TimestampNanoseconds
Parameters
value: int Underlying .Net type is long
Returns
None: Underlying .Net type is void
get_TimestampMilliseconds
Parameters
Returns
int: Underlying .Net type is long
get_Timestamp
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type DateTime
get_TimestampAsTimeSpan
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type TimeSpan
AddValue
Parameters
parameterId: str Underlying .Net type is string
value: float Underlying .Net type is double
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp
AddValue2
Parameters
parameterId: str Underlying .Net type is string
value: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp
AddValue3
Parameters
parameterId: str Underlying .Net type is string
value: c_void_p GC Handle Pointer to .Net type byte[]
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp
AddValue4
Parameters
parameterId: str Underlying .Net type is string
value: c_void_p GC Handle Pointer to .Net type ParameterValue
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp
RemoveValue
Parameters
parameterId: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp
AddTag
Parameters
tagId: str Underlying .Net type is string
tagValue: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp
AddTags
Parameters
tags: c_void_p
GC Handle Pointer to .Net type IEnumerable
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp
RemoveTag
Parameters
tagId: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp
Equals
Parameters
obj: c_void_p GC Handle Pointer to .Net type Object
Returns
bool: Underlying .Net type is Boolean
GetHashCode
Parameters
Returns
int: Underlying .Net type is int
ToString
Parameters
Returns
str: Underlying .Net type is string
quixstreams.native.Python.QuixStreamsStreaming.PackageReceivedEventArgs
PackageReceivedEventArgs Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type PackageReceivedEventArgs
Returns
PackageReceivedEventArgs: Instance wrapping the .net type PackageReceivedEventArgs
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type PackageReceivedEventArgs
Returns
PackageReceivedEventArgs: Instance wrapping the .net type PackageReceivedEventArgs
Constructor
@staticmethod
def Constructor(topicConsumer: c_void_p, consumer: c_void_p,
package: c_void_p) -> c_void_p
Parameters
topicConsumer: c_void_p GC Handle Pointer to .Net type ITopicConsumer
consumer: c_void_p GC Handle Pointer to .Net type IStreamConsumer
package: c_void_p GC Handle Pointer to .Net type StreamPackage
Returns
c_void_p: GC Handle Pointer to .Net type PackageReceivedEventArgs
get_TopicConsumer
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type ITopicConsumer
get_Stream
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type IStreamConsumer
get_Package
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type StreamPackage
quixstreams.native.Python.QuixStreamsStreaming.QuixStreamingClient
QuixStreamingClient Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type QuixStreamingClient
Returns
QuixStreamingClient: Instance wrapping the .net type QuixStreamingClient
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type QuixStreamingClient
Returns
QuixStreamingClient: Instance wrapping the .net type QuixStreamingClient
Constructor
@staticmethod
def Constructor(token: str = None,
autoCreateTopics: bool = True,
properties: c_void_p = None,
debug: bool = False,
httpClient: c_void_p = None) -> c_void_p
Parameters
token: str (Optional) Underlying .Net type is string. Defaults to None
autoCreateTopics: bool (Optional) Underlying .Net type is Boolean. Defaults to True
properties: c_void_p
(Optional) GC Handle Pointer to .Net type IDictionary
debug: bool (Optional) Underlying .Net type is Boolean. Defaults to False
httpClient: c_void_p (Optional) GC Handle Pointer to .Net type HttpClient. Defaults to None
Returns
c_void_p: GC Handle Pointer to .Net type QuixStreamingClient
get_TokenValidationConfig
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type QuixStreamingClient.TokenValidationConfiguration
set_TokenValidationConfig
Parameters
value: c_void_p GC Handle Pointer to .Net type QuixStreamingClient.TokenValidationConfiguration
Returns
None: Underlying .Net type is void
GetTopicConsumer
def GetTopicConsumer(
topicIdOrName: str,
consumerGroup: str = None,
options: c_void_p = None,
autoOffset: AutoOffsetReset = AutoOffsetReset.Latest) -> c_void_p
Parameters
topicIdOrName: str Underlying .Net type is string
consumerGroup: str (Optional) Underlying .Net type is string. Defaults to None
options: c_void_p (Optional) GC Handle Pointer to .Net type CommitOptions. Defaults to None
autoOffset: AutoOffsetReset (Optional) Underlying .Net type is AutoOffsetReset. Defaults to Latest
Returns
c_void_p: GC Handle Pointer to .Net type ITopicConsumer
GetRawTopicConsumer
def GetRawTopicConsumer(
topicIdOrName: str,
consumerGroup: str = None,
autoOffset: Optional[AutoOffsetReset] = None) -> c_void_p
Parameters
topicIdOrName: str Underlying .Net type is string
consumerGroup: str (Optional) Underlying .Net type is string. Defaults to None
autoOffset: Optional[AutoOffsetReset] (Optional) Underlying .Net type is AutoOffsetReset?. Defaults to None
Returns
c_void_p: GC Handle Pointer to .Net type IRawTopicConsumer
GetRawTopicProducer
Parameters
topicIdOrName: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type IRawTopicProducer
GetTopicProducer
Parameters
topicIdOrName: str Underlying .Net type is string
Returns
c_void_p: GC Handle Pointer to .Net type ITopicProducer
get_ApiUrl
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type Uri
set_ApiUrl
Parameters
value: c_void_p GC Handle Pointer to .Net type Uri
Returns
None: Underlying .Net type is void
get_CachePeriod
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type TimeSpan
set_CachePeriod
Parameters
value: c_void_p GC Handle Pointer to .Net type TimeSpan
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.QuixStreamingClientExtensions
QuixStreamingClientExtensions Objects
GetTopicConsumer
@staticmethod
def GetTopicConsumer(
client: c_void_p,
topicId: str,
consumerGroup: str = None,
commitMode: CommitMode = CommitMode.Automatic,
autoOffset: AutoOffsetReset = AutoOffsetReset.Latest) -> c_void_p
Parameters
client: c_void_p GC Handle Pointer to .Net type QuixStreamingClient
topicId: str Underlying .Net type is string
consumerGroup: str (Optional) Underlying .Net type is string. Defaults to None
commitMode: CommitMode (Optional) Underlying .Net type is CommitMode. Defaults to Automatic
autoOffset: AutoOffsetReset (Optional) Underlying .Net type is AutoOffsetReset. Defaults to Latest
Returns
c_void_p: GC Handle Pointer to .Net type ITopicConsumer
quixstreams.native.Python.QuixStreamsStreaming.QuixStreamingClient_TokenValidationConfiguration
TokenValidationConfiguration Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TokenValidationConfiguration
Returns
TokenValidationConfiguration: Instance wrapping the .net type TokenValidationConfiguration
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type TokenValidationConfiguration
Returns
TokenValidationConfiguration: Instance wrapping the .net type TokenValidationConfiguration
Constructor
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type QuixStreamingClient.TokenValidationConfiguration
get_Enabled
Parameters
Returns
bool: Underlying .Net type is Boolean
set_Enabled
Parameters
value: bool Underlying .Net type is Boolean
Returns
None: Underlying .Net type is void
get_WarningBeforeExpiry
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type TimeSpan?
set_WarningBeforeExpiry
Parameters
value: c_void_p GC Handle Pointer to .Net type TimeSpan?
Returns
None: Underlying .Net type is void
get_WarnAboutNonPatToken
Parameters
Returns
bool: Underlying .Net type is Boolean
set_WarnAboutNonPatToken
Parameters
value: bool Underlying .Net type is Boolean
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Raw.IRawTopicConsumer
IRawTopicConsumer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type IRawTopicConsumer
Returns
IRawTopicConsumer: Instance wrapping the .net type IRawTopicConsumer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type IRawTopicConsumer
Returns
IRawTopicConsumer: Instance wrapping the .net type IRawTopicConsumer
Subscribe
Parameters
Returns
None: Underlying .Net type is void
add_OnMessageReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnMessageReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
add_OnErrorOccurred
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnErrorOccurred
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
add_OnDisposed
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnDisposed
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Raw.IRawTopicProducer
IRawTopicProducer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type IRawTopicProducer
Returns
IRawTopicProducer: Instance wrapping the .net type IRawTopicProducer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type IRawTopicProducer
Returns
IRawTopicProducer: Instance wrapping the .net type IRawTopicProducer
Publish
Parameters
data: c_void_p GC Handle Pointer to .Net type RawMessage
Returns
None: Underlying .Net type is void
add_OnDisposed
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnDisposed
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Raw.RawMessage
RawMessage Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type RawMessage
Returns
RawMessage: Instance wrapping the .net type RawMessage
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type RawMessage
Returns
RawMessage: Instance wrapping the .net type RawMessage
Constructor
Parameters
key: c_void_p GC Handle Pointer to .Net type byte[]
value: c_void_p GC Handle Pointer to .Net type byte[]
Returns
c_void_p: GC Handle Pointer to .Net type RawMessage
Constructor2
Parameters
value: c_void_p GC Handle Pointer to .Net type byte[]
Returns
c_void_p: GC Handle Pointer to .Net type RawMessage
get_Metadata
Parameters
Returns
c_void_p:
GC Handle Pointer to .Net type ReadOnlyDictionary
get_Key
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type byte[]
set_Key
Parameters
value: c_void_p GC Handle Pointer to .Net type byte[]
Returns
None: Underlying .Net type is void
get_Value
Parameters
Returns
c_void_p: GC Handle Pointer to .Net type byte[]
set_Value
Parameters
value: c_void_p GC Handle Pointer to .Net type byte[]
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Raw.RawTopicConsumer
RawTopicConsumer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type RawTopicConsumer
Returns
RawTopicConsumer: Instance wrapping the .net type RawTopicConsumer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type RawTopicConsumer
Returns
RawTopicConsumer: Instance wrapping the .net type RawTopicConsumer
Constructor
@staticmethod
def Constructor(brokerAddress: str,
topicName: str,
consumerGroup: str,
brokerProperties: c_void_p = None,
autoOffset: Optional[AutoOffsetReset] = None) -> c_void_p
Parameters
brokerAddress: str Underlying .Net type is string
topicName: str Underlying .Net type is string
consumerGroup: str Underlying .Net type is string
brokerProperties: c_void_p
(Optional) GC Handle Pointer to .Net type Dictionary
autoOffset: Optional[AutoOffsetReset] (Optional) Underlying .Net type is AutoOffsetReset?. Defaults to None
Returns
c_void_p: GC Handle Pointer to .Net type RawTopicConsumer
add_OnMessageReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnMessageReceived
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
add_OnDisposed
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnDisposed
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
add_OnErrorOccurred
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnErrorOccurred
Parameters
value: Callable[[c_void_p, c_void_p], None]
Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
Subscribe
Parameters
Returns
None: Underlying .Net type is void
Dispose
Parameters
Returns
None: Underlying .Net type is void
quixstreams.native.Python.QuixStreamsStreaming.Raw.RawTopicProducer
RawTopicProducer Objects
__new__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type RawTopicProducer
Returns
RawTopicProducer: Instance wrapping the .net type RawTopicProducer
__init__
Parameters
net_pointer: c_void_p GC Handle Pointer to .Net type RawTopicProducer
Returns
RawTopicProducer: Instance wrapping the .net type RawTopicProducer
Constructor
@staticmethod
def Constructor(brokerAddress: str,
topicName: str,
brokerProperties: c_void_p = None) -> c_void_p
Parameters
brokerAddress: str Underlying .Net type is string
topicName: str Underlying .Net type is string
brokerProperties: c_void_p
(Optional) GC Handle Pointer to .Net type Dictionary
Returns
c_void_p: GC Handle Pointer to .Net type RawTopicProducer
add_OnDisposed
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
remove_OnDisposed
Parameters
value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler
Returns
None: Underlying .Net type is void
Publish
Parameters
message: c_void_p GC Handle Pointer to .Net type RawMessage
Returns
None: Underlying .Net type is void
Dispose
Parameters
Returns
None: Underlying .Net type is void