Class ListServiceInstancesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListServiceInstancesRequest.Builder,
ListServiceInstancesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<ListServiceInstancesFilter> filters()
An array of filtering criteria that scope down the result list.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Filters property.final int
hashCode()
final Integer
The maximum number of service instances to list.final String
A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.static Class
<? extends ListServiceInstancesRequest.Builder> final String
The name of the service that the service instance belongs to.sortBy()
The field that the result list is sorted by.final String
The field that the result list is sorted by.final SortOrder
Result list sort order.final String
Result list sort order.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.
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:
- An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.
-
maxResults
The maximum number of service instances to list.
- Returns:
- The maximum number of service instances to list.
-
nextToken
A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.
- Returns:
- A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.
-
serviceName
The name of the service that the service instance belongs to.
- Returns:
- The name of the service that the service instance belongs to.
-
sortBy
The field that the result list is sorted by.
When you choose to sort by
serviceName
, service instances within each service are sorted by service instance name.Default:
serviceName
If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnListServiceInstancesSortBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The field that the result list is sorted by.
When you choose to sort by
serviceName
, service instances within each service are sorted by service instance name.Default:
serviceName
- See Also:
-
sortByAsString
The field that the result list is sorted by.
When you choose to sort by
serviceName
, service instances within each service are sorted by service instance name.Default:
serviceName
If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnListServiceInstancesSortBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The field that the result list is sorted by.
When you choose to sort by
serviceName
, service instances within each service are sorted by service instance name.Default:
serviceName
- See Also:
-
sortOrder
Result list sort order.
Default:
ASCENDING
If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- Result list sort order.
Default:
ASCENDING
- See Also:
-
sortOrderAsString
Result list sort order.
Default:
ASCENDING
If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- Result list sort order.
Default:
ASCENDING
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListServiceInstancesRequest.Builder,
ListServiceInstancesRequest> - Specified by:
toBuilder
in classProtonRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in 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
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
Description copied from class:SdkRequest
Used 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:
getValueForField
in 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
-