Skip to content

Commit 68b488c

Browse files
committed
rename KenisisDataStream to KenisisEvent
1 parent b0491c2 commit 68b488c

File tree

13 files changed

+58
-58
lines changed

13 files changed

+58
-58
lines changed

docs/snippets/batch/templates/kinesis.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Resources:
2222
Type: AWS::Serverless::Function
2323
Properties:
2424
CodeUri: ./src/HelloWorld/
25-
Handler: HelloWorld::HelloWorld.Function::KinesisDataStreamHandlerUsingAttribute
25+
Handler: HelloWorld::HelloWorld.Function::KinesisEventHandlerUsingAttribute
2626
Policies:
2727
# Lambda Destinations require additional permissions
2828
# to send failure records to DLQ from Kinesis/DynamoDB

docs/utilities/batch-processing.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -237,12 +237,12 @@ Processing batches from Kinesis using Lambda handler decorator works in three st
237237
1. Decorate your handler with **`BatchProcessor`** attribute
238238
2. Create a class that implements **`IKinesisEventRecordHandler`** interface and the HandleAsync method.
239239
3. Pass the type of that class to **`RecordHandler`** property of the **`BatchProcessor`** attribute
240-
4. Return **`BatchItemFailuresResponse`** from Lambda handler using **`KinesisDataStreamBatchProcessor.Result.BatchItemFailuresResponse`**
240+
4. Return **`BatchItemFailuresResponse`** from Lambda handler using **`KinesisEventBatchProcessor.Result.BatchItemFailuresResponse`**
241241

242242
=== "Function.cs"
243243

244244
```csharp hl_lines="1 7 12 17 20"
245-
internal class CustomKinesisDataStreamRecordHandler : IKinesisEventRecordHandler // (1)!
245+
internal class CustomKinesisEventRecordHandler : IKinesisEventRecordHandler // (1)!
246246
{
247247
public async Task<RecordHandlerResult> HandleAsync(KinesisEvent.KinesisEventRecord record, CancellationToken cancellationToken)
248248
{
@@ -258,10 +258,10 @@ Processing batches from Kinesis using Lambda handler decorator works in three st
258258
}
259259

260260

261-
[BatchProcessor(RecordHandler = typeof(CustomKinesisDataStreamRecordHandler))]
261+
[BatchProcessor(RecordHandler = typeof(CustomKinesisEventRecordHandler))]
262262
public BatchItemFailuresResponse HandlerUsingAttribute(KinesisEvent _)
263263
{
264-
return KinesisDataStreamBatchProcessor.Result.BatchItemFailuresResponse; // (4)!
264+
return KinesisEventBatchProcessor.Result.BatchItemFailuresResponse; // (4)!
265265
}
266266

267267
```
@@ -729,7 +729,7 @@ sequenceDiagram
729729

730730
You can use Batch processing without using the decorator.
731731

732-
Calling the **`ProcessAsync`** method on the Instance of the static BatchProcessor (`SqsBatchProcessor`, `DynamoDbStreamBatchProcessor`, `KinesisDataStreamBatchProcessor`)
732+
Calling the **`ProcessAsync`** method on the Instance of the static BatchProcessor (`SqsBatchProcessor`, `DynamoDbStreamBatchProcessor`, `KinesisEventBatchProcessor`)
733733

734734
=== "Function.cs"
735735

@@ -750,7 +750,7 @@ Calling the **`ProcessAsync`** method on the Instance of the static BatchProcess
750750

751751
```
752752

753-
To make the handler testable you can use Dependency Injection to resolve the BatchProcessor (`SqsBatchProcessor`, `DynamoDbStreamBatchProcessor`, `KinesisDataStreamBatchProcessor`) instance and then call the **`ProcessAsync`** method.
753+
To make the handler testable you can use Dependency Injection to resolve the BatchProcessor (`SqsBatchProcessor`, `DynamoDbStreamBatchProcessor`, `KinesisEventBatchProcessor`) instance and then call the **`ProcessAsync`** method.
754754

755755
=== "GetRequiredService inside the method"
756756

@@ -840,7 +840,7 @@ You can also set `POWERTOOLS_BATCH_MAX_DEGREE_OF_PARALLELISM` Environment Variab
840840

841841
You might want to bring custom logic to the existing `BatchProcessor` to slightly override how we handle successes and failures.
842842

843-
For these scenarios, you can create a class that inherits from `BatchProcessor` (`SqsBatchProcessor`, `DynamoDbStreamBatchProcessor`, `KinesisDataStreamBatchProcessor`) and quickly override `ProcessAsync` and `HandleRecordFailureAsync` methods:
843+
For these scenarios, you can create a class that inherits from `BatchProcessor` (`SqsBatchProcessor`, `DynamoDbStreamBatchProcessor`, `KinesisEventBatchProcessor`) and quickly override `ProcessAsync` and `HandleRecordFailureAsync` methods:
844844

845845
* **`ProcessAsync()`** – Keeps track of successful batch records
846846
* **`HandleRecordFailureAsync()`** – Keeps track of failed batch records

examples/BatchProcessing/src/HelloWorld/Function.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ public BatchItemFailuresResponse DynamoDbStreamHandlerUsingAttribute(DynamoDBEve
4949
return DynamoDbStreamBatchProcessor.Result.BatchItemFailuresResponse;
5050
}
5151

52-
[BatchProcessor(RecordHandler = typeof(CustomKinesisDataStreamRecordHandler))]
52+
[BatchProcessor(RecordHandler = typeof(CustomKinesisEventRecordHandler))]
5353
[Logging(LogEvent = true)]
54-
public BatchItemFailuresResponse KinesisDataStreamHandlerUsingAttribute(KinesisEvent _)
54+
public BatchItemFailuresResponse KinesisEventHandlerUsingAttribute(KinesisEvent _)
5555
{
56-
return KinesisDataStreamBatchProcessor.Result.BatchItemFailuresResponse;
56+
return KinesisEventBatchProcessor.Result.BatchItemFailuresResponse;
5757
}
5858

5959
[BatchProcessor(RecordHandler = typeof(CustomSqsRecordHandler))]

examples/BatchProcessing/src/HelloWorld/Kinesis/CustomKinesisDataStreamRecordHandler.cs renamed to examples/BatchProcessing/src/HelloWorld/Kinesis/CustomKinesisEventRecordHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
using HelloWorld.Data;
2525

2626
namespace HelloWorld.Kinesis;
27-
internal class CustomKinesisDataStreamRecordHandler : IKinesisEventRecordHandler
27+
internal class CustomKinesisEventRecordHandler : IKinesisEventRecordHandler
2828
{
2929
public async Task<RecordHandlerResult> HandleAsync(KinesisEvent.KinesisEventRecord record, CancellationToken cancellationToken)
3030
{

examples/BatchProcessing/template.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,13 +127,13 @@ Resources:
127127

128128
# --------------
129129
# Batch Processing for Kinesis Data Streams
130-
SampleKinesisDataStreamBatchProcessorFunction:
130+
SampleKinesisEventBatchProcessorFunction:
131131
Type: AWS::Serverless::Function
132132
Properties:
133133
FunctionName: powertools-dotnet-sample-batch-processor-kinesis-data-stream
134134
Runtime: dotnet6
135135
CodeUri: ./src/HelloWorld/
136-
Handler: HelloWorld::HelloWorld.Function::KinesisDataStreamHandlerUsingAttribute
136+
Handler: HelloWorld::HelloWorld.Function::KinesisEventHandlerUsingAttribute
137137
MemorySize: 256
138138
# ReservedConcurrentExecutions: 1
139139
Policies:

examples/BatchProcessing/test/HelloWorld.Test/FunctionTest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ public Task TestKinesis()
213213

214214
// Act
215215
var function = new Function();
216-
var response = function.KinesisDataStreamHandlerUsingAttribute(request);
216+
var response = function.KinesisEventHandlerUsingAttribute(request);
217217

218218
foreach (var failure in response.BatchItemFailures)
219219
{

libraries/src/AWS.Lambda.Powertools.BatchProcessing/BatchProcessorAttribute.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ private IBatchProcessingAspectHandler CreateAspectHandler(IReadOnlyList<object>
251251
return eventType switch
252252
{
253253
BatchEventType.DynamoDbStream => CreateBatchProcessingAspectHandler(() => DynamoDbStreamBatchProcessor.Instance),
254-
BatchEventType.KinesisDataStream => CreateBatchProcessingAspectHandler(() => KinesisDataStreamBatchProcessor.Instance),
254+
BatchEventType.KinesisDataStream => CreateBatchProcessingAspectHandler(() => KinesisEventBatchProcessor.Instance),
255255
BatchEventType.Sqs => CreateBatchProcessingAspectHandler(() => SqsBatchProcessor.Instance),
256256
_ => throw new ArgumentOutOfRangeException(nameof(eventType), eventType, "Unsupported event type.")
257257
};

libraries/src/AWS.Lambda.Powertools.BatchProcessing/Kinesis/KinesisDataStreamBatchProcessor.cs renamed to libraries/src/AWS.Lambda.Powertools.BatchProcessing/Kinesis/KinesisEventBatchProcessor.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,24 +22,24 @@ namespace AWS.Lambda.Powertools.BatchProcessing.Kinesis;
2222
/// <summary>
2323
/// The default batch processor for Kinesis Data Stream events.
2424
/// </summary>
25-
public class KinesisDataStreamBatchProcessor : BatchProcessor<KinesisEvent, KinesisEvent.KinesisEventRecord>
25+
public class KinesisEventBatchProcessor : BatchProcessor<KinesisEvent, KinesisEvent.KinesisEventRecord>
2626
{
2727
/// <summary>
2828
/// The singleton instance of the batch processor.
2929
/// </summary>
30-
private static KinesisDataStreamBatchProcessor _instance;
30+
private static KinesisEventBatchProcessor _instance;
3131

3232
/// <summary>
3333
/// The singleton instance of the batch processor.
3434
/// </summary>
35-
public static KinesisDataStreamBatchProcessor Instance =>
36-
_instance ??= new KinesisDataStreamBatchProcessor(PowertoolsConfigurations.Instance);
35+
public static KinesisEventBatchProcessor Instance =>
36+
_instance ??= new KinesisEventBatchProcessor(PowertoolsConfigurations.Instance);
3737

3838
/// <summary>
3939
/// This is the default constructor
4040
/// </summary>
4141
/// <param name="powertoolsConfigurations"></param>
42-
public KinesisDataStreamBatchProcessor(IPowertoolsConfigurations powertoolsConfigurations) : base(powertoolsConfigurations)
42+
public KinesisEventBatchProcessor(IPowertoolsConfigurations powertoolsConfigurations) : base(powertoolsConfigurations)
4343
{
4444
_instance = this;
4545
}
@@ -48,7 +48,7 @@ public KinesisDataStreamBatchProcessor(IPowertoolsConfigurations powertoolsConfi
4848
/// Need default constructor for when consumers create a custom batch processor
4949
/// </summary>
5050
// ReSharper disable once MemberCanBePrivate.Global
51-
protected KinesisDataStreamBatchProcessor() : this(PowertoolsConfigurations.Instance)
51+
protected KinesisEventBatchProcessor() : this(PowertoolsConfigurations.Instance)
5252
{
5353
}
5454

libraries/tests/AWS.Lambda.Powertools.BatchProcessing.Tests/Handlers/Kinesis/Custom/CustomKinesisBatchProcessors.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
namespace AWS.Lambda.Powertools.BatchProcessing.Tests.Handlers.Kinesis.Custom;
2727

28-
internal class CustomKinesisDataStreamBatchProcessor : KinesisDataStreamBatchProcessor
28+
internal class CustomKinesisEventBatchProcessor : KinesisEventBatchProcessor
2929
{
3030
public override async Task<ProcessingResult<KinesisEvent.KinesisEventRecord>> ProcessAsync(KinesisEvent @event,
3131
IRecordHandler<KinesisEvent.KinesisEventRecord> recordHandler, ProcessingOptions processingOptions)
@@ -125,14 +125,14 @@ protected override async Task HandleRecordFailureAsync(KinesisEvent.KinesisEvent
125125
}
126126
}
127127

128-
internal class CustomKinesisDataStreamBatchProcessorProvider : IBatchProcessorProvider<KinesisEvent, KinesisEvent.KinesisEventRecord>
128+
internal class CustomKinesisEventBatchProcessorProvider : IBatchProcessorProvider<KinesisEvent, KinesisEvent.KinesisEventRecord>
129129
{
130130
public IBatchProcessor<KinesisEvent, KinesisEvent.KinesisEventRecord> Create()
131131
{
132-
return Services.Provider.GetRequiredService<CustomKinesisDataStreamBatchProcessor>();
132+
return Services.Provider.GetRequiredService<CustomKinesisEventBatchProcessor>();
133133
}
134134
}
135135

136-
public class BadCustomKinesisDataStreamRecordProcessor
136+
public class BadCustomKinesisEventRecordProcessor
137137
{
138138
}

libraries/tests/AWS.Lambda.Powertools.BatchProcessing.Tests/Handlers/Kinesis/Custom/CustomKinesisHandlers.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
namespace AWS.Lambda.Powertools.BatchProcessing.Tests.Handlers.Kinesis.Custom;
2424

25-
internal class CustomKinesisDataStreamRecordHandler : IKinesisEventRecordHandler
25+
internal class CustomKinesisEventRecordHandler : IKinesisEventRecordHandler
2626
{
2727
public async Task<RecordHandlerResult> HandleAsync(KinesisEvent.KinesisEventRecord record,
2828
CancellationToken cancellationToken)
@@ -38,7 +38,7 @@ public async Task<RecordHandlerResult> HandleAsync(KinesisEvent.KinesisEventReco
3838
}
3939
}
4040

41-
internal class CustomFailKinesisDataStreamRecordHandler : IKinesisEventRecordHandler
41+
internal class CustomFailKinesisEventRecordHandler : IKinesisEventRecordHandler
4242
{
4343
public Task<RecordHandlerResult> HandleAsync(KinesisEvent.KinesisEventRecord record,
4444
CancellationToken cancellationToken)
@@ -47,6 +47,6 @@ public Task<RecordHandlerResult> HandleAsync(KinesisEvent.KinesisEventRecord rec
4747
}
4848
}
4949

50-
public class BadCustomKinesisRecordHandler
50+
public class BadCustomKinesisEventRecordHandler
5151
{
5252
}

0 commit comments

Comments
 (0)