Streamable.RegisterInput Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
RegisterInput<TPartitionKey,TPayload>(QueryContainer, IObservable<PartitionedStreamEvent<TPartitionKey, TPayload>>, OnCompletedPolicy, PartitionedDisorderPolicy, PartitionedPeriodicPunctuationPolicy, String) |
Converts a sequence of PartitionedStreamEvents to an IStreamable.
The completion policy specifies what to do when the resulting stream completes.
The disorder policy specifies what to do with out of order events.
The punctuation policy specifies whether and how punctuations are created and injected |
RegisterInput<TPartitionKey,TPayload>(QueryContainer, IObservable<PartitionedStreamEvent<TPartitionKey, TPayload>>, OnCompletedPolicy, PartitionedPeriodicPunctuationPolicy, String) |
Converts a sequence of PartitionedStreamEvents to an IStreamable.
The completion policy specifies what to do when the resulting stream completes.
The disorder policy specifies what to do with out of order events.
The punctuation policy specifies whether and how punctuations are created and injected |
RegisterInput<TPartitionKey,TPayload>(QueryContainer, IObservable<ArraySegment<PartitionedStreamEvent<TPartitionKey, TPayload>>>, OnCompletedPolicy, String) |
Converts a sequence of PartitionedStreamEvents to an IStreamable.
The completion policy specifies what to do when the resulting stream completes.
The disorder policy specifies what to do with out of order events.
The punctuation policy specifies whether and how punctuations are created and injected |
RegisterInput<TPayload>(QueryContainer, IObservable<StreamEvent<TPayload>>, OnCompletedPolicy, PeriodicPunctuationPolicy, String) |
Converts a sequence of StreamEvents to an IStreamable.
The completion policy specifies what to do when the resulting stream completes.
The disorder policy specifies what to do with out of order events.
The punctuation policy specifies whether and how punctuations are created and injected |
RegisterInput<TPayload>(QueryContainer, IObservable<ArraySegment<StreamEvent<TPayload>>>, OnCompletedPolicy, String) |
Converts a sequence of StreamEvents to an IStreamable.
The completion policy specifies what to do when the resulting stream completes.
The disorder policy specifies what to do with out of order events.
The punctuation policy specifies whether and how punctuations are created and injected |
RegisterInput<TPayload>(QueryContainer, IObservable<StreamEvent<TPayload>>, OnCompletedPolicy, DisorderPolicy, PeriodicPunctuationPolicy, String) |
Converts a sequence of StreamEvents to an IStreamable.
The completion policy specifies what to do when the resulting stream completes.
The disorder policy specifies what to do with out of order events.
The punctuation policy specifies whether and how punctuations are created and injected |
RegisterInput<TPartitionKey,TPayload>(QueryContainer, IObservable<PartitionedStreamEvent<TPartitionKey, TPayload>>, OnCompletedPolicy, PartitionedDisorderPolicy, PartitionedPeriodicPunctuationPolicy, String)
Converts a sequence of PartitionedStreamEvents to an IStreamable.
The completion policy specifies what to do when the resulting stream completes.
The disorder policy specifies what to do with out of order events.
The punctuation policy specifies whether and how punctuations are created and injected
into the resulting stream. Since punctuations force output, this exposes a throughput/latency tradeoff.
public static Microsoft.StreamProcessing.IPartitionedIngressStreamable<TPartitionKey,TPayload> RegisterInput<TPartitionKey,TPayload> (this Microsoft.StreamProcessing.QueryContainer container, IObservable<Microsoft.StreamProcessing.PartitionedStreamEvent<TPartitionKey,TPayload>> streamEvents, Microsoft.StreamProcessing.OnCompletedPolicy onCompletedPolicy, Microsoft.StreamProcessing.PartitionedDisorderPolicy disorderPolicy = null, Microsoft.StreamProcessing.PartitionedPeriodicPunctuationPolicy periodicPunctuationPolicy = null, string identifier = null);
static member RegisterInput : Microsoft.StreamProcessing.QueryContainer * IObservable<Microsoft.StreamProcessing.PartitionedStreamEvent<'PartitionKey, 'Payload>> * Microsoft.StreamProcessing.OnCompletedPolicy * Microsoft.StreamProcessing.PartitionedDisorderPolicy * Microsoft.StreamProcessing.PartitionedPeriodicPunctuationPolicy * string -> Microsoft.StreamProcessing.IPartitionedIngressStreamable<'PartitionKey, 'Payload>
Type Parameters
- TPartitionKey
The type of partition key for the stream.
- TPayload
The type of data for the stream.
Parameters
- container
- QueryContainer
The query container to which to register the ingress point.
- streamEvents
- IObservable<PartitionedStreamEvent<TPartitionKey,TPayload>>
A sequence of stream events created by the client.
- onCompletedPolicy
- OnCompletedPolicy
How to handle the completion of a stream.
- disorderPolicy
- PartitionedDisorderPolicy
How to handle events that are not in time order.
- periodicPunctuationPolicy
- PartitionedPeriodicPunctuationPolicy
Whether to add periodic punctuations to the resulting stream.
- identifier
- String
If provided, a unique name to identify to point of ingress in the query.
Returns
An IStreamable that can be used in queries.
Exceptions
Throws an exception if the disorderPolicy
is to throw and
an out-of-order stream event is encountered.
Also, an exception is thrown if any payload is null.
Applies to
RegisterInput<TPartitionKey,TPayload>(QueryContainer, IObservable<PartitionedStreamEvent<TPartitionKey, TPayload>>, OnCompletedPolicy, PartitionedPeriodicPunctuationPolicy, String)
Converts a sequence of PartitionedStreamEvents to an IStreamable.
The completion policy specifies what to do when the resulting stream completes.
The disorder policy specifies what to do with out of order events.
The punctuation policy specifies whether and how punctuations are created and injected
into the resulting stream. Since punctuations force output, this exposes a throughput/latency tradeoff.
public static Microsoft.StreamProcessing.IPartitionedIngressStreamable<TPartitionKey,TPayload> RegisterInput<TPartitionKey,TPayload> (this Microsoft.StreamProcessing.QueryContainer container, IObservable<Microsoft.StreamProcessing.PartitionedStreamEvent<TPartitionKey,TPayload>> streamEvents, Microsoft.StreamProcessing.OnCompletedPolicy onCompletedPolicy, Microsoft.StreamProcessing.PartitionedPeriodicPunctuationPolicy periodicPunctuationPolicy, string identifier = null);
static member RegisterInput : Microsoft.StreamProcessing.QueryContainer * IObservable<Microsoft.StreamProcessing.PartitionedStreamEvent<'PartitionKey, 'Payload>> * Microsoft.StreamProcessing.OnCompletedPolicy * Microsoft.StreamProcessing.PartitionedPeriodicPunctuationPolicy * string -> Microsoft.StreamProcessing.IPartitionedIngressStreamable<'PartitionKey, 'Payload>
Type Parameters
- TPartitionKey
The type of partition key for the stream.
- TPayload
The type of data for the stream.
Parameters
- container
- QueryContainer
The query container to which to register the ingress point.
- streamEvents
- IObservable<PartitionedStreamEvent<TPartitionKey,TPayload>>
A sequence of stream events created by the client.
- onCompletedPolicy
- OnCompletedPolicy
How to handle the completion of a stream.
- periodicPunctuationPolicy
- PartitionedPeriodicPunctuationPolicy
Whether to add periodic punctuations to the resulting stream.
- identifier
- String
If provided, a unique name to identify to point of ingress in the query.
Returns
An IStreamable that can be used in queries.
Exceptions
Throws an exception if an out-of-order stream event is encountered. Also, an exception is thrown if any payload is null.
Applies to
RegisterInput<TPartitionKey,TPayload>(QueryContainer, IObservable<ArraySegment<PartitionedStreamEvent<TPartitionKey, TPayload>>>, OnCompletedPolicy, String)
Converts a sequence of PartitionedStreamEvents to an IStreamable.
The completion policy specifies what to do when the resulting stream completes.
The disorder policy specifies what to do with out of order events.
The punctuation policy specifies whether and how punctuations are created and injected
into the resulting stream. Since punctuations force output, this exposes a throughput/latency tradeoff.
public static Microsoft.StreamProcessing.IPartitionedIngressStreamable<TPartitionKey,TPayload> RegisterInput<TPartitionKey,TPayload> (this Microsoft.StreamProcessing.QueryContainer container, IObservable<ArraySegment<Microsoft.StreamProcessing.PartitionedStreamEvent<TPartitionKey,TPayload>>> streamEvents, Microsoft.StreamProcessing.OnCompletedPolicy onCompletedPolicy, string identifier = null);
static member RegisterInput : Microsoft.StreamProcessing.QueryContainer * IObservable<ArraySegment<Microsoft.StreamProcessing.PartitionedStreamEvent<'PartitionKey, 'Payload>>> * Microsoft.StreamProcessing.OnCompletedPolicy * string -> Microsoft.StreamProcessing.IPartitionedIngressStreamable<'PartitionKey, 'Payload>
Type Parameters
- TPartitionKey
The type of partition key for the stream.
- TPayload
The type of data for the stream.
Parameters
- container
- QueryContainer
The query container to which to register the ingress point.
- streamEvents
- IObservable<ArraySegment<PartitionedStreamEvent<TPartitionKey,TPayload>>>
A sequence of stream events created by the client.
- onCompletedPolicy
- OnCompletedPolicy
How to handle the completion of a stream.
- identifier
- String
If provided, a unique name to identify to point of ingress in the query.
Returns
An IStreamable that can be used in queries.
Exceptions
Throws an exception if an out-of-order stream event is encountered. Also, an exception is thrown if any payload is null.
Applies to
RegisterInput<TPayload>(QueryContainer, IObservable<StreamEvent<TPayload>>, OnCompletedPolicy, PeriodicPunctuationPolicy, String)
Converts a sequence of StreamEvents to an IStreamable.
The completion policy specifies what to do when the resulting stream completes.
The disorder policy specifies what to do with out of order events.
The punctuation policy specifies whether and how punctuations are created and injected
into the resulting stream. Since punctuations force output, this exposes a throughput/latency tradeoff.
public static Microsoft.StreamProcessing.IObservableIngressStreamable<TPayload> RegisterInput<TPayload> (this Microsoft.StreamProcessing.QueryContainer container, IObservable<Microsoft.StreamProcessing.StreamEvent<TPayload>> streamEvents, Microsoft.StreamProcessing.OnCompletedPolicy onCompletedPolicy, Microsoft.StreamProcessing.PeriodicPunctuationPolicy periodicPunctuationPolicy, string identifier = null);
static member RegisterInput : Microsoft.StreamProcessing.QueryContainer * IObservable<Microsoft.StreamProcessing.StreamEvent<'Payload>> * Microsoft.StreamProcessing.OnCompletedPolicy * Microsoft.StreamProcessing.PeriodicPunctuationPolicy * string -> Microsoft.StreamProcessing.IObservableIngressStreamable<'Payload>
Type Parameters
- TPayload
The type of data for the stream.
Parameters
- container
- QueryContainer
The query container to which to register the ingress point.
- streamEvents
- IObservable<StreamEvent<TPayload>>
A sequence of stream events created by the client.
- onCompletedPolicy
- OnCompletedPolicy
How to handle the completion of a stream.
- periodicPunctuationPolicy
- PeriodicPunctuationPolicy
Whether to add periodic punctuations to the resulting stream.
- identifier
- String
If provided, a unique name to identify to point of ingress in the query.
Returns
An IStreamable that can be used in queries.
Exceptions
Throws an exception if an out-of-order stream event is encountered. Also, an exception is thrown if any payload is null.
Applies to
RegisterInput<TPayload>(QueryContainer, IObservable<ArraySegment<StreamEvent<TPayload>>>, OnCompletedPolicy, String)
Converts a sequence of StreamEvents to an IStreamable.
The completion policy specifies what to do when the resulting stream completes.
The disorder policy specifies what to do with out of order events.
The punctuation policy specifies whether and how punctuations are created and injected
into the resulting stream. Since punctuations force output, this exposes a throughput/latency tradeoff.
public static Microsoft.StreamProcessing.IObservableIngressStreamable<TPayload> RegisterInput<TPayload> (this Microsoft.StreamProcessing.QueryContainer container, IObservable<ArraySegment<Microsoft.StreamProcessing.StreamEvent<TPayload>>> streamEvents, Microsoft.StreamProcessing.OnCompletedPolicy onCompletedPolicy, string identifier = null);
static member RegisterInput : Microsoft.StreamProcessing.QueryContainer * IObservable<ArraySegment<Microsoft.StreamProcessing.StreamEvent<'Payload>>> * Microsoft.StreamProcessing.OnCompletedPolicy * string -> Microsoft.StreamProcessing.IObservableIngressStreamable<'Payload>
Type Parameters
- TPayload
The type of data for the stream.
Parameters
- container
- QueryContainer
The query container to which to register the ingress point.
- streamEvents
- IObservable<ArraySegment<StreamEvent<TPayload>>>
A sequence of stream events created by the client.
- onCompletedPolicy
- OnCompletedPolicy
How to handle the completion of a stream.
- identifier
- String
If provided, a unique name to identify to point of ingress in the query.
Returns
An IStreamable that can be used in queries.
Exceptions
Throws an exception if an out-of-order stream event is encountered. Also, an exception is thrown if any payload is null.
Applies to
RegisterInput<TPayload>(QueryContainer, IObservable<StreamEvent<TPayload>>, OnCompletedPolicy, DisorderPolicy, PeriodicPunctuationPolicy, String)
Converts a sequence of StreamEvents to an IStreamable.
The completion policy specifies what to do when the resulting stream completes.
The disorder policy specifies what to do with out of order events.
The punctuation policy specifies whether and how punctuations are created and injected
into the resulting stream. Since punctuations force output, this exposes a throughput/latency tradeoff.
public static Microsoft.StreamProcessing.IObservableIngressStreamable<TPayload> RegisterInput<TPayload> (this Microsoft.StreamProcessing.QueryContainer container, IObservable<Microsoft.StreamProcessing.StreamEvent<TPayload>> streamEvents, Microsoft.StreamProcessing.OnCompletedPolicy onCompletedPolicy, Microsoft.StreamProcessing.DisorderPolicy disorderPolicy = null, Microsoft.StreamProcessing.PeriodicPunctuationPolicy periodicPunctuationPolicy = null, string identifier = null);
static member RegisterInput : Microsoft.StreamProcessing.QueryContainer * IObservable<Microsoft.StreamProcessing.StreamEvent<'Payload>> * Microsoft.StreamProcessing.OnCompletedPolicy * Microsoft.StreamProcessing.DisorderPolicy * Microsoft.StreamProcessing.PeriodicPunctuationPolicy * string -> Microsoft.StreamProcessing.IObservableIngressStreamable<'Payload>
Type Parameters
- TPayload
The type of data for the stream.
Parameters
- container
- QueryContainer
The query container to which to register the ingress point.
- streamEvents
- IObservable<StreamEvent<TPayload>>
A sequence of stream events created by the client.
- onCompletedPolicy
- OnCompletedPolicy
How to handle the completion of a stream.
- disorderPolicy
- DisorderPolicy
How to handle events that are not in time order.
- periodicPunctuationPolicy
- PeriodicPunctuationPolicy
Whether to add periodic punctuations to the resulting stream.
- identifier
- String
If provided, a unique name to identify to point of ingress in the query.
Returns
An IStreamable that can be used in queries.
Exceptions
Throws an exception if the disorderPolicy
is to throw and
an out-of-order stream event is encountered.
Also, an exception is thrown if any payload is null.