Package 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:

SdkPojo, ToCopyableBuilder<RegisterStreamConsumerRequest.Builder,RegisterStreamConsumerRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegisterStreamConsumerRequest.Builder

Method Summary

Modifier and Type	Method	Description
static RegisterStreamConsumerRequest.Builder	builder()
String	consumerName()	For a given Kinesis data stream, each consumer must have a unique name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RegisterStreamConsumerRequest.Builder>	serializableBuilderClass()
String	streamARN()	The ARN of the Kinesis data stream that you want to register the consumer with.
Map<String,String>	tags()	A set of up to 50 key-value pairs.
RegisterStreamConsumerRequest.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

streamARN

public final 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 Amazon Web Services 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 Amazon Web Services Service Namespaces.

consumerName

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

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

A set of up to 50 key-value pairs. A tag consists of a required key and an optional value.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A set of up to 50 key-value pairs. A tag consists of a required key and an optional value.

toBuilder

public RegisterStreamConsumerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterStreamConsumerRequest.Builder,RegisterStreamConsumerRequest>

Specified by:

toBuilder in class KinesisRequest

builder

public static RegisterStreamConsumerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RegisterStreamConsumerRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo