Package software.amazon.awssdk.services.proton.model

Class ListServiceInstancesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.proton.model.ProtonRequest

software.amazon.awssdk.services.proton.model.ListServiceInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListServiceInstancesRequest.Builder,ListServiceInstancesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListServiceInstancesRequest
extends ProtonRequest
implements ToCopyableBuilder<ListServiceInstancesRequest.Builder,ListServiceInstancesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListServiceInstancesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListServiceInstancesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<ListServiceInstancesFilter>	filters()	An array of filtering criteria that scope down the result list.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
Integer	maxResults()	The maximum number of service instances to list.
String	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.
List<SdkField<?>>	sdkFields()
static Class<? extends ListServiceInstancesRequest.Builder>	serializableBuilderClass()
String	serviceName()	The name of the service that the service instance belongs to.
ListServiceInstancesSortBy	sortBy()	The field that the result list is sorted by.
String	sortByAsString()	The field that the result list is sorted by.
SortOrder	sortOrder()	Result list sort order.
String	sortOrderAsString()	Result list sort order.
ListServiceInstancesRequest.Builder	toBuilder()
String	toString()	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

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 the isEmpty() 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<ListServiceInstancesFilter> 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

public final Integer maxResults()

The maximum number of service instances to list.

Returns:

The maximum number of service instances to list.

nextToken

public final String 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

public final String 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

public final ListServiceInstancesSortBy 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 return ListServiceInstancesSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

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:

ListServiceInstancesSortBy

sortByAsString

public final String 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 return ListServiceInstancesSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

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:

ListServiceInstancesSortBy

sortOrder

public final SortOrder 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 return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

Result list sort order.

Default: ASCENDING

See Also:

SortOrder

sortOrderAsString

public final String 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 return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

Result list sort order.

Default: ASCENDING

See Also:

SortOrder

toBuilder

public ListServiceInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListServiceInstancesRequest.Builder,ListServiceInstancesRequest>

Specified by:

toBuilder in class ProtonRequest

builder

public static ListServiceInstancesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListServiceInstancesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo