Interface SubscribeToShardRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SubscribeToShardRequest.Builder,SubscribeToShardRequest>
,KinesisRequest.Builder
,SdkBuilder<SubscribeToShardRequest.Builder,SubscribeToShardRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- SubscribeToShardRequest
public static interface SubscribeToShardRequest.Builder extends KinesisRequest.Builder, SdkPojo, CopyableBuilder<SubscribeToShardRequest.Builder,SubscribeToShardRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description SubscribeToShardRequest.Builder
consumerARN(String consumerARN)
For this parameter, use the value you obtained when you called RegisterStreamConsumer.SubscribeToShardRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SubscribeToShardRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SubscribeToShardRequest.Builder
shardId(String shardId)
The ID of the shard you want to subscribe to.default SubscribeToShardRequest.Builder
startingPosition(Consumer<StartingPosition.Builder> startingPosition)
The starting position in the data stream from which to start streaming.SubscribeToShardRequest.Builder
startingPosition(StartingPosition startingPosition)
The starting position in the data stream from which to start streaming.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.kinesis.model.KinesisRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
consumerARN
SubscribeToShardRequest.Builder consumerARN(String consumerARN)
For this parameter, use the value you obtained when you called RegisterStreamConsumer.
- Parameters:
consumerARN
- For this parameter, use the value you obtained when you called RegisterStreamConsumer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
shardId
SubscribeToShardRequest.Builder shardId(String shardId)
The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.
- Parameters:
shardId
- The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startingPosition
SubscribeToShardRequest.Builder startingPosition(StartingPosition startingPosition)
The starting position in the data stream from which to start streaming.
- Parameters:
startingPosition
- The starting position in the data stream from which to start streaming.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startingPosition
default SubscribeToShardRequest.Builder startingPosition(Consumer<StartingPosition.Builder> startingPosition)
The starting position in the data stream from which to start streaming.
This is a convenience method that creates an instance of theStartingPosition.Builder
avoiding the need to create one manually viaStartingPosition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostartingPosition(StartingPosition)
.- Parameters:
startingPosition
- a consumer that will call methods onStartingPosition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
startingPosition(StartingPosition)
-
overrideConfiguration
SubscribeToShardRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
SubscribeToShardRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-