Interface ListWorldsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListWorldsRequest.Builder,ListWorldsRequest>,RoboMakerRequest.Builder,SdkBuilder<ListWorldsRequest.Builder,ListWorldsRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ListWorldsRequest
public static interface ListWorldsRequest.Builder extends RoboMakerRequest.Builder, SdkPojo, CopyableBuilder<ListWorldsRequest.Builder,ListWorldsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListWorldsRequest.Builderfilters(Collection<Filter> filters)Optional filters to limit results.ListWorldsRequest.Builderfilters(Consumer<Filter.Builder>... filters)Optional filters to limit results.ListWorldsRequest.Builderfilters(Filter... filters)Optional filters to limit results.ListWorldsRequest.BuildermaxResults(Integer maxResults)When this parameter is used,ListWorldsonly returnsmaxResultsresults in a single page along with anextTokenresponse element.ListWorldsRequest.BuildernextToken(String nextToken)If the previous paginated request did not return all of the remaining results, the response object'snextTokenparameter value is set to a token.ListWorldsRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ListWorldsRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.robomaker.model.RoboMakerRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
nextToken
ListWorldsRequest.Builder nextToken(String nextToken)
If the previous paginated request did not return all of the remaining results, the response object's
nextTokenparameter value is set to a token. To retrieve the next set of results, callListWorldsagain and assign that token to the request object'snextTokenparameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.- Parameters:
nextToken- If the previous paginated request did not return all of the remaining results, the response object'snextTokenparameter value is set to a token. To retrieve the next set of results, callListWorldsagain and assign that token to the request object'snextTokenparameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
ListWorldsRequest.Builder maxResults(Integer maxResults)
When this parameter is used,
ListWorldsonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListWorldsrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter is not used, thenListWorldsreturns up to 100 results and anextTokenvalue if applicable.- Parameters:
maxResults- When this parameter is used,ListWorldsonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListWorldsrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter is not used, thenListWorldsreturns up to 100 results and anextTokenvalue if applicable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
ListWorldsRequest.Builder filters(Collection<Filter> filters)
Optional filters to limit results. You can use
status.- Parameters:
filters- Optional filters to limit results. You can usestatus.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
ListWorldsRequest.Builder filters(Filter... filters)
Optional filters to limit results. You can use
status.- Parameters:
filters- Optional filters to limit results. You can usestatus.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
ListWorldsRequest.Builder filters(Consumer<Filter.Builder>... filters)
Optional filters to limit results. You can use
This is a convenience method that creates an instance of thestatus.Filter.Builderavoiding the need to create one manually viaFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#filters(List.) - Parameters:
filters- a consumer that will call methods onFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#filters(java.util.Collection)
-
overrideConfiguration
ListWorldsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ListWorldsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-