Class ListQueuesRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListQueuesRequest.Builder,ListQueuesRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic ListQueuesRequest.Builderbuilder()final booleanfinal booleanequalsBySdkFields(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 extendsSdkRequest.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the StreamFilter property.final IntegerThe maximum number of queue summaries to return in one response.final StringTheNextTokenreturned by a previousListQueuesrequest.static Class<? extends ListQueuesRequest.Builder> final List<QueueStreamFilter> Lists only the queues created on the specified data stream.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
maxResults
The maximum number of queue summaries to return in one response. The response might contain fewer summaries than this value, and might contain a
NextTokeneven when it contains fewer.- Returns:
- The maximum number of queue summaries to return in one response. The response might contain fewer
summaries than this value, and might contain a
NextTokeneven when it contains fewer.
-
nextToken
The
NextTokenreturned by a previousListQueuesrequest. Use it to retrieve the next page of queue summaries.- Returns:
- The
NextTokenreturned by a previousListQueuesrequest. Use it to retrieve the next page of queue summaries.
-
hasStreamFilter
public final boolean hasStreamFilter()For responses, this returns true if the service returned a value for the StreamFilter 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. -
streamFilter
Lists only the queues created on the specified data stream.
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
hasStreamFilter()method.- Returns:
- Lists only the queues created on the specified data stream.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ListQueuesRequest.Builder,ListQueuesRequest> - Specified by:
toBuilderin classKinesisRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin 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
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-