Class ListStreamConsumersRequest
- 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.ListStreamConsumersRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListStreamConsumersRequest.Builder,ListStreamConsumersRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListStreamConsumersRequest extends KinesisRequest implements ToCopyableBuilder<ListStreamConsumersRequest.Builder,ListStreamConsumersRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ListStreamConsumersRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListStreamConsumersRequest.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Integer
maxResults()
The maximum number of consumers that you want a single call ofListStreamConsumers
to return.String
nextToken()
When the number of consumers that are registered with the data stream is greater than the default value for theMaxResults
parameter, or if you explicitly specify a value forMaxResults
that is less than the number of consumers that are registered with the data stream, the response includes a pagination token namedNextToken
.List<SdkField<?>>
sdkFields()
static Class<? extends ListStreamConsumersRequest.Builder>
serializableBuilderClass()
String
streamARN()
The ARN of the Kinesis data stream for which you want to list the registered consumers.Instant
streamCreationTimestamp()
Specify this input parameter to distinguish data streams that have the same name.ListStreamConsumersRequest.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 for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
- Returns:
- The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
-
nextToken
public final 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 forMaxResults
that is less than the number of consumers that are registered with the data stream, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call toListStreamConsumers
to list the next set of registered consumers.Don't specify
StreamName
orStreamCreationTimestamp
if you specifyNextToken
because the latter unambiguously identifies the stream.You can optionally specify a value for the
MaxResults
parameter when you specifyNextToken
. If you specify aMaxResults
value that is less than the number of consumers that the operation returns if you don't specifyMaxResults
, the response will contain a newNextToken
value. You can use the newNextToken
value in a subsequent call to theListStreamConsumers
operation to list the next set of consumers.Tokens expire after 300 seconds. When you obtain a value for
NextToken
in the response to a call toListStreamConsumers
, you have 300 seconds to use that value. If you specify an expired token in a call toListStreamConsumers
, you getExpiredNextTokenException
.- 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 forMaxResults
that is less than the number of consumers that are registered with the data stream, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call toListStreamConsumers
to list the next set of registered consumers.Don't specify
StreamName
orStreamCreationTimestamp
if you specifyNextToken
because the latter unambiguously identifies the stream.You can optionally specify a value for the
MaxResults
parameter when you specifyNextToken
. If you specify aMaxResults
value that is less than the number of consumers that the operation returns if you don't specifyMaxResults
, the response will contain a newNextToken
value. You can use the newNextToken
value in a subsequent call to theListStreamConsumers
operation to list the next set of consumers.Tokens expire after 300 seconds. When you obtain a value for
NextToken
in the response to a call toListStreamConsumers
, you have 300 seconds to use that value. If you specify an expired token in a call toListStreamConsumers
, you getExpiredNextTokenException
.
-
maxResults
public final Integer maxResults()
The maximum number of consumers that you want a single call of
ListStreamConsumers
to return. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.- Returns:
- The maximum number of consumers that you want a single call of
ListStreamConsumers
to return. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.
-
streamCreationTimestamp
public final Instant streamCreationTimestamp()
Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.
You can't specify this parameter if you specify the NextToken parameter.
- Returns:
- Specify this input parameter to distinguish data streams that have the same name. For example, if you
create a data stream and then delete it, and you later create another data stream with the same name, you
can use this input parameter to specify which of the two streams you want to list the consumers for.
You can't specify this parameter if you specify the NextToken parameter.
-
toBuilder
public ListStreamConsumersRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListStreamConsumersRequest.Builder,ListStreamConsumersRequest>
- Specified by:
toBuilder
in classKinesisRequest
-
builder
public static ListStreamConsumersRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListStreamConsumersRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-