Class ListSimulationJobsRequest
- 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.ListSimulationJobsRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListSimulationJobsRequest.Builder,ListSimulationJobsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListSimulationJobsRequest extends RoboMakerRequest implements ToCopyableBuilder<ListSimulationJobsRequest.Builder,ListSimulationJobsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceListSimulationJobsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListSimulationJobsRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<Filter>filters()Optional filters to limit results.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasFilters()For responses, this returns true if the service returned a value for the Filters property.inthashCode()IntegermaxResults()When this parameter is used,ListSimulationJobsonly returnsmaxResultsresults in a single page along with anextTokenresponse element.StringnextToken()If the previous paginated request did not return all of the remaining results, the response object'snextTokenparameter value is set to a token.List<SdkField<?>>sdkFields()static Class<? extends ListSimulationJobsRequest.Builder>serializableBuilderClass()ListSimulationJobsRequest.BuildertoBuilder()StringtoString()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
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.- Returns:
- 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.
-
maxResults
public final 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.- Returns:
- 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.
-
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 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.
-
filters
public final List<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.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.
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.
-
toBuilder
public ListSimulationJobsRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListSimulationJobsRequest.Builder,ListSimulationJobsRequest>- Specified by:
toBuilderin classRoboMakerRequest
-
builder
public static ListSimulationJobsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListSimulationJobsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-