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

Class DeregisterStreamConsumerRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeregisterStreamConsumerRequest.Builder,DeregisterStreamConsumerRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeregisterStreamConsumerRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DeregisterStreamConsumerRequest.Builder	builder()
String	consumerARN()	The ARN returned by Kinesis Data Streams when you registered the consumer.
String	consumerName()	The name that you gave to the consumer.
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 DeregisterStreamConsumerRequest.Builder>	serializableBuilderClass()
String	streamARN()	The ARN of the Kinesis data stream that the consumer is registered with.
DeregisterStreamConsumerRequest.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 the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Returns:

The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

consumerName

public final String consumerName()

The name that you gave to the consumer.

Returns:

The name that you gave to the consumer.

consumerARN

public final String consumerARN()

The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.

Returns:

The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.

toBuilder

public DeregisterStreamConsumerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeregisterStreamConsumerRequest.Builder,DeregisterStreamConsumerRequest>

Specified by:

toBuilder in class KinesisRequest

builder

public static DeregisterStreamConsumerRequest.Builder builder()

serializableBuilderClass

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