-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
598062d
commit 08e966a
Showing
12 changed files
with
249 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
39 changes: 39 additions & 0 deletions
39
...treamingClient.GetTopicConsumer(string,PartitionOffset,string,CommitOptions).md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| #### [QuixStreams.Streaming](index.md 'index') | ||
| ### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[IKafkaStreamingClient](IKafkaStreamingClient.md 'QuixStreams.Streaming.IKafkaStreamingClient') | ||
|
|
||
| ## IKafkaStreamingClient.GetTopicConsumer(string, PartitionOffset, string, CommitOptions) Method | ||
|
|
||
| Gets a topic consumer capable of subscribing to receive incoming streams. | ||
|
|
||
| ```csharp | ||
| QuixStreams.Streaming.ITopicConsumer GetTopicConsumer(string topic, QuixStreams.Kafka.PartitionOffset partitionOffset, string consumerGroup=null, QuixStreams.Kafka.Transport.CommitOptions options=null); | ||
| ``` | ||
| #### Parameters | ||
|
|
||
| <a name='QuixStreams.Streaming.IKafkaStreamingClient.GetTopicConsumer(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).topic'></a> | ||
|
|
||
| `topic` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
|
|
||
| Name of the topic. | ||
|
|
||
| <a name='QuixStreams.Streaming.IKafkaStreamingClient.GetTopicConsumer(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).partitionOffset'></a> | ||
|
|
||
| `partitionOffset` [QuixStreams.Kafka.PartitionOffset](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Kafka.PartitionOffset 'QuixStreams.Kafka.PartitionOffset') | ||
|
|
||
| The partition offset to start reading from | ||
|
|
||
| <a name='QuixStreams.Streaming.IKafkaStreamingClient.GetTopicConsumer(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).consumerGroup'></a> | ||
|
|
||
| `consumerGroup` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
|
|
||
| The consumer group id to use for consuming messages. If null, consumer group is not used and only consuming new messages. | ||
|
|
||
| <a name='QuixStreams.Streaming.IKafkaStreamingClient.GetTopicConsumer(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).options'></a> | ||
|
|
||
| `options` [QuixStreams.Kafka.Transport.CommitOptions](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Kafka.Transport.CommitOptions 'QuixStreams.Kafka.Transport.CommitOptions') | ||
|
|
||
| The settings to use for committing | ||
|
|
||
| #### Returns | ||
| [ITopicConsumer](ITopicConsumer.md 'QuixStreams.Streaming.ITopicConsumer') | ||
| Instance of [ITopicConsumer](ITopicConsumer.md 'QuixStreams.Streaming.ITopicConsumer') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
39 changes: 39 additions & 0 deletions
39
...treamingClient.GetTopicConsumer(string,PartitionOffset,string,CommitOptions).md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| #### [QuixStreams.Streaming](index.md 'index') | ||
| ### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[IQuixStreamingClient](IQuixStreamingClient.md 'QuixStreams.Streaming.IQuixStreamingClient') | ||
|
|
||
| ## IQuixStreamingClient.GetTopicConsumer(string, PartitionOffset, string, CommitOptions) Method | ||
|
|
||
| Gets a topic consumer capable of subscribing to receive incoming streams. | ||
|
|
||
| ```csharp | ||
| QuixStreams.Streaming.ITopicConsumer GetTopicConsumer(string topicIdOrName, QuixStreams.Kafka.PartitionOffset partitionOffset, string consumerGroup=null, QuixStreams.Kafka.Transport.CommitOptions options=null); | ||
| ``` | ||
| #### Parameters | ||
|
|
||
| <a name='QuixStreams.Streaming.IQuixStreamingClient.GetTopicConsumer(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).topicIdOrName'></a> | ||
|
|
||
| `topicIdOrName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
|
|
||
| Id or name of the topic. If name is provided, workspace will be derived from environment variable or token, in that order | ||
|
|
||
| <a name='QuixStreams.Streaming.IQuixStreamingClient.GetTopicConsumer(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).partitionOffset'></a> | ||
|
|
||
| `partitionOffset` [QuixStreams.Kafka.PartitionOffset](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Kafka.PartitionOffset 'QuixStreams.Kafka.PartitionOffset') | ||
|
|
||
| The partition offset to start reading from | ||
|
|
||
| <a name='QuixStreams.Streaming.IQuixStreamingClient.GetTopicConsumer(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).consumerGroup'></a> | ||
|
|
||
| `consumerGroup` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
|
|
||
| The consumer group id to use for consuming messages. If null, consumer group is not used and only consuming new messages. | ||
|
|
||
| <a name='QuixStreams.Streaming.IQuixStreamingClient.GetTopicConsumer(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).options'></a> | ||
|
|
||
| `options` [QuixStreams.Kafka.Transport.CommitOptions](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Kafka.Transport.CommitOptions 'QuixStreams.Kafka.Transport.CommitOptions') | ||
|
|
||
| The settings to use for committing | ||
|
|
||
| #### Returns | ||
| [ITopicConsumer](ITopicConsumer.md 'QuixStreams.Streaming.ITopicConsumer') | ||
| Instance of [ITopicConsumer](ITopicConsumer.md 'QuixStreams.Streaming.ITopicConsumer') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
39 changes: 39 additions & 0 deletions
39
...ientAsync.GetTopicConsumerAsync(string,PartitionOffset,string,CommitOptions).md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| #### [QuixStreams.Streaming](index.md 'index') | ||
| ### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[IQuixStreamingClientAsync](IQuixStreamingClientAsync.md 'QuixStreams.Streaming.IQuixStreamingClientAsync') | ||
|
|
||
| ## IQuixStreamingClientAsync.GetTopicConsumerAsync(string, PartitionOffset, string, CommitOptions) Method | ||
|
|
||
| Asynchronously gets a topic consumer capable of subscribing to receive incoming streams. | ||
|
|
||
| ```csharp | ||
| System.Threading.Tasks.Task<QuixStreams.Streaming.ITopicConsumer> GetTopicConsumerAsync(string topicIdOrName, QuixStreams.Kafka.PartitionOffset partitionOffset, string consumerGroup=null, QuixStreams.Kafka.Transport.CommitOptions options=null); | ||
| ``` | ||
| #### Parameters | ||
|
|
||
| <a name='QuixStreams.Streaming.IQuixStreamingClientAsync.GetTopicConsumerAsync(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).topicIdOrName'></a> | ||
|
|
||
| `topicIdOrName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
|
|
||
| Id or name of the topic. If name is provided, workspace will be derived from environment variable or token, in that order | ||
|
|
||
| <a name='QuixStreams.Streaming.IQuixStreamingClientAsync.GetTopicConsumerAsync(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).partitionOffset'></a> | ||
|
|
||
| `partitionOffset` [QuixStreams.Kafka.PartitionOffset](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Kafka.PartitionOffset 'QuixStreams.Kafka.PartitionOffset') | ||
|
|
||
| The partition offset to start reading from | ||
|
|
||
| <a name='QuixStreams.Streaming.IQuixStreamingClientAsync.GetTopicConsumerAsync(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).consumerGroup'></a> | ||
|
|
||
| `consumerGroup` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
|
|
||
| The consumer group id to use for consuming messages. If null, consumer group is not used and only consuming new messages. | ||
|
|
||
| <a name='QuixStreams.Streaming.IQuixStreamingClientAsync.GetTopicConsumerAsync(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).options'></a> | ||
|
|
||
| `options` [QuixStreams.Kafka.Transport.CommitOptions](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Kafka.Transport.CommitOptions 'QuixStreams.Kafka.Transport.CommitOptions') | ||
|
|
||
| The settings to use for committing | ||
|
|
||
| #### Returns | ||
| [System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')[ITopicConsumer](ITopicConsumer.md 'QuixStreams.Streaming.ITopicConsumer')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1') | ||
| A task returning an instance of [ITopicConsumer](ITopicConsumer.md 'QuixStreams.Streaming.ITopicConsumer') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 41 additions & 0 deletions
41
...treamingClient.GetTopicConsumer(string,PartitionOffset,string,CommitOptions).md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| #### [QuixStreams.Streaming](index.md 'index') | ||
| ### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[KafkaStreamingClient](KafkaStreamingClient.md 'QuixStreams.Streaming.KafkaStreamingClient') | ||
|
|
||
| ## KafkaStreamingClient.GetTopicConsumer(string, PartitionOffset, string, CommitOptions) Method | ||
|
|
||
| Gets a topic consumer capable of subscribing to receive incoming streams. | ||
|
|
||
| ```csharp | ||
| public QuixStreams.Streaming.ITopicConsumer GetTopicConsumer(string topic, QuixStreams.Kafka.PartitionOffset partitionOffset, string consumerGroup=null, QuixStreams.Kafka.Transport.CommitOptions options=null); | ||
| ``` | ||
| #### Parameters | ||
|
|
||
| <a name='QuixStreams.Streaming.KafkaStreamingClient.GetTopicConsumer(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).topic'></a> | ||
|
|
||
| `topic` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
|
|
||
| Name of the topic. | ||
|
|
||
| <a name='QuixStreams.Streaming.KafkaStreamingClient.GetTopicConsumer(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).partitionOffset'></a> | ||
|
|
||
| `partitionOffset` [QuixStreams.Kafka.PartitionOffset](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Kafka.PartitionOffset 'QuixStreams.Kafka.PartitionOffset') | ||
|
|
||
| The partition offset to start reading from | ||
|
|
||
| <a name='QuixStreams.Streaming.KafkaStreamingClient.GetTopicConsumer(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).consumerGroup'></a> | ||
|
|
||
| `consumerGroup` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
|
|
||
| The consumer group id to use for consuming messages. If null, consumer group is not used and only consuming new messages. | ||
|
|
||
| <a name='QuixStreams.Streaming.KafkaStreamingClient.GetTopicConsumer(string,QuixStreams.Kafka.PartitionOffset,string,QuixStreams.Kafka.Transport.CommitOptions).options'></a> | ||
|
|
||
| `options` [QuixStreams.Kafka.Transport.CommitOptions](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Kafka.Transport.CommitOptions 'QuixStreams.Kafka.Transport.CommitOptions') | ||
|
|
||
| The settings to use for committing | ||
|
|
||
| Implements [GetTopicConsumer(string, PartitionOffset, string, CommitOptions)](IKafkaStreamingClient.GetTopicConsumer(string,PartitionOffset,string,CommitOptions).md 'QuixStreams.Streaming.IKafkaStreamingClient.GetTopicConsumer(string, QuixStreams.Kafka.PartitionOffset, string, QuixStreams.Kafka.Transport.CommitOptions)') | ||
|
|
||
| #### Returns | ||
| [ITopicConsumer](ITopicConsumer.md 'QuixStreams.Streaming.ITopicConsumer') | ||
| Instance of [ITopicConsumer](ITopicConsumer.md 'QuixStreams.Streaming.ITopicConsumer') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.