java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.supplychain.model.SupplyChainRequest
    - - software.amazon.awssdk.services.supplychain.model.ListInstancesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListInstancesRequest.Builder,ListInstancesRequest>

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

The request parameters for ListInstances.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListInstancesRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListInstancesRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasInstanceNameFilter()`	For responses, this returns true if the service returned a value for the InstanceNameFilter property.
`boolean`	`hasInstanceStateFilter()`	For responses, this returns true if the service returned a value for the InstanceStateFilter property.
`List<String>`	`instanceNameFilter()`	The filter to ListInstances based on their names.
`List<InstanceState>`	`instanceStateFilter()`	The filter to ListInstances based on their state.
`List<String>`	`instanceStateFilterAsStrings()`	The filter to ListInstances based on their state.
`Integer`	`maxResults()`	Specify the maximum number of instances to fetch in this paginated request.
`String`	`nextToken()`	The pagination token to fetch the next page of instances.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListInstancesRequest.Builder>`	`serializableBuilderClass()`
`ListInstancesRequest.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
  - nextToken
```
public final String nextToken()
```
    The pagination token to fetch the next page of instances.
    
    Returns:
    
    The pagination token to fetch the next page of instances.
  - maxResults
```
public final Integer maxResults()
```
    Specify the maximum number of instances to fetch in this paginated request.
    
    Returns:
    
    Specify the maximum number of instances to fetch in this paginated request.
  - hasInstanceNameFilter
```
public final boolean hasInstanceNameFilter()
```
    For responses, this returns true if the service returned a value for the InstanceNameFilter 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.
  - instanceNameFilter
```
public final List<String> instanceNameFilter()
```
    The filter to ListInstances based on their names.
    
    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 hasInstanceNameFilter() method.
    
    Returns:
    
    The filter to ListInstances based on their names.
  - instanceStateFilter
```
public final List<InstanceState> instanceStateFilter()
```
    The filter to ListInstances based on their state.
    
    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 hasInstanceStateFilter() method.
    
    Returns:
    
    The filter to ListInstances based on their state.
  - hasInstanceStateFilter
```
public final boolean hasInstanceStateFilter()
```
    For responses, this returns true if the service returned a value for the InstanceStateFilter 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.
  - instanceStateFilterAsStrings
```
public final List<String> instanceStateFilterAsStrings()
```
    The filter to ListInstances based on their state.
    
    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 hasInstanceStateFilter() method.
    
    Returns:
    
    The filter to ListInstances based on their state.
  - toBuilder
```
public ListInstancesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListInstancesRequest.Builder,ListInstancesRequest>
    
    Specified by:
    
    toBuilder in class SupplyChainRequest
  - builder
```
public static ListInstancesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListInstancesRequest.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ListInstancesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

nextToken

maxResults

hasInstanceNameFilter

instanceNameFilter

instanceStateFilter

hasInstanceStateFilter

instanceStateFilterAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField