Package software.amazon.awssdk.services.kinesis.model

Class SubscribeToShardRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kinesis.model.KinesisRequest

software.amazon.awssdk.services.kinesis.model.SubscribeToShardRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SubscribeToShardRequest.Builder,SubscribeToShardRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SubscribeToShardRequest
extends KinesisRequest
implements ToCopyableBuilder<SubscribeToShardRequest.Builder,SubscribeToShardRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SubscribeToShardRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SubscribeToShardRequest.Builder	builder()
String	consumerARN()	For this parameter, use the value you obtained when you called RegisterStreamConsumer.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SubscribeToShardRequest.Builder>	serializableBuilderClass()
String	shardId()	The ID of the shard you want to subscribe to.
StartingPosition	startingPosition()	The starting position in the data stream from which to start streaming.
SubscribeToShardRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

consumerARN

public final String consumerARN()

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

Returns:

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

shardId

public final 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.

Returns:

The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

startingPosition

public final StartingPosition startingPosition()

The starting position in the data stream from which to start streaming.

Returns:

The starting position in the data stream from which to start streaming.

toBuilder

public SubscribeToShardRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SubscribeToShardRequest.Builder,SubscribeToShardRequest>

Specified by:

toBuilder in class KinesisRequest

builder

public static SubscribeToShardRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SubscribeToShardRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo