Package software.amazon.awssdk.services.robomaker.model

Class ListWorldsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.robomaker.model.RoboMakerRequest

software.amazon.awssdk.services.robomaker.model.ListWorldsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListWorldsRequest.Builder,ListWorldsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListWorldsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListWorldsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	Optional filters to limit results.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
Integer	maxResults()	When this parameter is used, ListWorlds only returns maxResults results in a single page along with a nextToken response element.
String	nextToken()	If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token.
List<SdkField<?>>	sdkFields()
static Class<? extends ListWorldsRequest.Builder>	serializableBuilderClass()
ListWorldsRequest.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

nextToken

public final String nextToken()

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

maxResults

public final Integer maxResults()

When this parameter is used, ListWorlds only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.

Returns:

When this parameter is used, ListWorlds only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

filters

public final List<Filter> filters()

Optional filters to limit results. You can use status.

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 hasFilters() method.

Returns:

Optional filters to limit results. You can use status.

toBuilder

public ListWorldsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListWorldsRequest.Builder,ListWorldsRequest>

Specified by:

toBuilder in class RoboMakerRequest

builder

public static ListWorldsRequest.Builder builder()

serializableBuilderClass

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