software.amazon.awssdk.services.kinesis.model

Class RegisterStreamConsumerRequest

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.RegisterStreamConsumerRequest

All Implemented Interfaces:

ToCopyableBuilder<RegisterStreamConsumerRequest.Builder,RegisterStreamConsumerRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegisterStreamConsumerRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RegisterStreamConsumerRequest.Builder	builder()
String	consumerName() For a given Kinesis data stream, each consumer must have a unique name.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
static Class<? extends RegisterStreamConsumerRequest.Builder>	serializableBuilderClass()
String	streamARN() The ARN of the Kinesis data stream that you want to register the consumer with.
RegisterStreamConsumerRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

streamARN

public String streamARN()

The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Returns:

The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

consumerName

public String consumerName()

For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.

Returns:

For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.

toBuilder

public RegisterStreamConsumerRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterStreamConsumerRequest.Builder,RegisterStreamConsumerRequest>

Specified by:

toBuilder in class KinesisRequest

Returns:

a builder for type T

builder

public static RegisterStreamConsumerRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value