software.amazon.awssdk.services.kinesis.model

Class ListStreamConsumersResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kinesis.model.KinesisResponse

software.amazon.awssdk.services.kinesis.model.ListStreamConsumersResponse

All Implemented Interfaces:

ToCopyableBuilder<ListStreamConsumersResponse.Builder,ListStreamConsumersResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListStreamConsumersResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ListStreamConsumersResponse.Builder	builder()
List<Consumer>	consumers() An array of JSON objects.
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 SdkResponse.
int	hashCode()
String	nextToken() When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken.
static Class<? extends ListStreamConsumersResponse.Builder>	serializableBuilderClass()
ListStreamConsumersResponse.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.core.SdkResponse

sdkHttpResponse

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

consumers

public List<Consumer> consumers()

An array of JSON objects. Each object represents one registered consumer.

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

Returns:

An array of JSON objects. Each object represents one registered consumer.

nextToken

public String nextToken()

When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

Returns:

When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

toBuilder

public ListStreamConsumersResponse.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<ListStreamConsumersResponse.Builder,ListStreamConsumersResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static ListStreamConsumersResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ListStreamConsumersResponse.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: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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