Class ListWorldExportJobsRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListWorldExportJobsRequest.Builder,ListWorldExportJobsRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.filters()Optional filters to limit results.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final booleanFor responses, this returns true if the service returned a value for the Filters property.final inthashCode()final IntegerWhen this parameter is used,ListWorldExportJobsonly returnsmaxResultsresults in a single page along with anextTokenresponse element.final StringIf the previous paginated request did not return all of the remaining results, the response object'snextTokenparameter value is set to a token.static Class<? extends ListWorldExportJobsRequest.Builder> 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
-
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, callListWorldExportJobsagain 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, callListWorldExportJobsagain 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
When this parameter is used,
ListWorldExportJobsonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListWorldExportJobsrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter is not used, thenListWorldExportJobsreturns up to 100 results and anextTokenvalue if applicable.- Returns:
- When this parameter is used,
ListWorldExportJobsonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListWorldExportJobsrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter is not used, thenListWorldExportJobsreturns up to 100 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
Optional filters to limit results. You can use
generationJobIdandtemplateId.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
generationJobIdandtemplateId.
-
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<ListWorldExportJobsRequest.Builder,ListWorldExportJobsRequest> - Specified by:
toBuilderin classRoboMakerRequest- 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.
-