Class ListStreamConsumersResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListStreamConsumersResponse.Builder,
ListStreamConsumersResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
An array of JSON objects.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the Consumers property.final int
hashCode()
final String
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 registered consumers, the response includes a pagination token namedNextToken
.static Class
<? extends ListStreamConsumersResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.kinesis.model.KinesisResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasConsumers
public final boolean hasConsumers()For responses, this returns true if the service returned a value for the Consumers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.
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
hasConsumers()
method.- Returns:
- An array of JSON objects. Each object represents one registered consumer.
-
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 registered consumers, 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. For more information about the use of this pagination token when calling theListStreamConsumers
operation, see ListStreamConsumersInput$NextToken.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 registered consumers, 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. For more information about the use of this pagination token when calling theListStreamConsumers
operation, see ListStreamConsumersInput$NextToken.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
.
-
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 interfaceToCopyableBuilder<ListStreamConsumersResponse.Builder,
ListStreamConsumersResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-
sdkFields
-