Interface ListSimulationJobsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListSimulationJobsRequest.Builder,ListSimulationJobsRequest>,RoboMakerRequest.Builder,SdkBuilder<ListSimulationJobsRequest.Builder,ListSimulationJobsRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ListSimulationJobsRequest
public static interface ListSimulationJobsRequest.Builder extends RoboMakerRequest.Builder, SdkPojo, CopyableBuilder<ListSimulationJobsRequest.Builder,ListSimulationJobsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListSimulationJobsRequest.Builderfilters(Collection<Filter> filters)Optional filters to limit results.ListSimulationJobsRequest.Builderfilters(Consumer<Filter.Builder>... filters)Optional filters to limit results.ListSimulationJobsRequest.Builderfilters(Filter... filters)Optional filters to limit results.ListSimulationJobsRequest.BuildermaxResults(Integer maxResults)When this parameter is used,ListSimulationJobsonly returnsmaxResultsresults in a single page along with anextTokenresponse element.ListSimulationJobsRequest.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.ListSimulationJobsRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ListSimulationJobsRequest.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
ListSimulationJobsRequest.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, callListSimulationJobsagain 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, callListSimulationJobsagain 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
ListSimulationJobsRequest.Builder maxResults(Integer maxResults)
When this parameter is used,
ListSimulationJobsonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListSimulationJobsrequest with the returnednextTokenvalue. This value can be between 1 and 1000. If this parameter is not used, thenListSimulationJobsreturns up to 1000 results and anextTokenvalue if applicable.- Parameters:
maxResults- When this parameter is used,ListSimulationJobsonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListSimulationJobsrequest with the returnednextTokenvalue. This value can be between 1 and 1000. If this parameter is not used, thenListSimulationJobsreturns up to 1000 results and anextTokenvalue if applicable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
ListSimulationJobsRequest.Builder filters(Collection<Filter> filters)
Optional filters to limit results.
The filter names
statusandsimulationApplicationNameandrobotApplicationNameare supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the statusPreparingor the statusRunning.- Parameters:
filters- Optional filters to limit results.The filter names
statusandsimulationApplicationNameandrobotApplicationNameare supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the statusPreparingor the statusRunning.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
ListSimulationJobsRequest.Builder filters(Filter... filters)
Optional filters to limit results.
The filter names
statusandsimulationApplicationNameandrobotApplicationNameare supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the statusPreparingor the statusRunning.- Parameters:
filters- Optional filters to limit results.The filter names
statusandsimulationApplicationNameandrobotApplicationNameare supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the statusPreparingor the statusRunning.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
ListSimulationJobsRequest.Builder filters(Consumer<Filter.Builder>... filters)
Optional filters to limit results.
The filter names
This is a convenience method that creates an instance of thestatusandsimulationApplicationNameandrobotApplicationNameare supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the statusPreparingor the statusRunning.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
ListSimulationJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ListSimulationJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-