ListInstancesRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.emr.model.EmrRequest
    - - software.amazon.awssdk.services.emr.model.ListInstancesRequest

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

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

This input determines which instances to list.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListInstancesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ListInstancesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListInstancesRequest.Builder`	`builder()`
`String`	`clusterId()` The identifier of the cluster for which to list the instances.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`boolean`	`hasInstanceGroupTypes()` Returns true if the InstanceGroupTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasInstanceStates()` Returns true if the InstanceStates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`instanceFleetId()` The unique identifier of the instance fleet.
`InstanceFleetType`	`instanceFleetType()` The node type of the instance fleet.
`String`	`instanceFleetTypeAsString()` The node type of the instance fleet.
`String`	`instanceGroupId()` The identifier of the instance group for which to list the instances.
`List<InstanceGroupType>`	`instanceGroupTypes()` The type of instance group for which to list the instances.
`List<String>`	`instanceGroupTypesAsStrings()` The type of instance group for which to list the instances.
`List<InstanceState>`	`instanceStates()` A list of instance states that will filter the instances returned with this request.
`List<String>`	`instanceStatesAsStrings()` A list of instance states that will filter the instances returned with this request.
`String`	`marker()` The pagination token that indicates the next set of results to retrieve.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListInstancesRequest.Builder>`	`serializableBuilderClass()`
`ListInstancesRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`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
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - clusterId
```
public final String clusterId()
```
    The identifier of the cluster for which to list the instances.
    
    Returns:
    
    The identifier of the cluster for which to list the instances.
  - instanceGroupId
```
public final String instanceGroupId()
```
    The identifier of the instance group for which to list the instances.
    
    Returns:
    
    The identifier of the instance group for which to list the instances.
  - instanceGroupTypes
```
public final List<InstanceGroupType> instanceGroupTypes()
```
    The type of instance group for which to list the instances.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasInstanceGroupTypes() to see if a value was sent in this field.
    
    Returns:
    
    The type of instance group for which to list the instances.
  - hasInstanceGroupTypes
```
public final boolean hasInstanceGroupTypes()
```
    Returns true if the InstanceGroupTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - instanceGroupTypesAsStrings
```
public final List<String> instanceGroupTypesAsStrings()
```
    The type of instance group for which to list the instances.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasInstanceGroupTypes() to see if a value was sent in this field.
    
    Returns:
    
    The type of instance group for which to list the instances.
  - instanceFleetId
```
public final String instanceFleetId()
```
    The unique identifier of the instance fleet.
    
    Returns:
    
    The unique identifier of the instance fleet.
  - instanceFleetType
```
public final InstanceFleetType instanceFleetType()
```
    The node type of the instance fleet. For example MASTER, CORE, or TASK.
    
    If the service returns an enum value that is not available in the current SDK version, instanceFleetType will return InstanceFleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceFleetTypeAsString().
    
    Returns:
    
    The node type of the instance fleet. For example MASTER, CORE, or TASK.
    
    See Also:
    
    InstanceFleetType
  - instanceFleetTypeAsString
```
public final String instanceFleetTypeAsString()
```
    The node type of the instance fleet. For example MASTER, CORE, or TASK.
    
    If the service returns an enum value that is not available in the current SDK version, instanceFleetType will return InstanceFleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceFleetTypeAsString().
    
    Returns:
    
    The node type of the instance fleet. For example MASTER, CORE, or TASK.
    
    See Also:
    
    InstanceFleetType
  - instanceStates
```
public final List<InstanceState> instanceStates()
```
    A list of instance states that will filter the instances returned with this request.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasInstanceStates() to see if a value was sent in this field.
    
    Returns:
    
    A list of instance states that will filter the instances returned with this request.
  - hasInstanceStates
```
public final boolean hasInstanceStates()
```
    Returns true if the InstanceStates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - instanceStatesAsStrings
```
public final List<String> instanceStatesAsStrings()
```
    A list of instance states that will filter the instances returned with this request.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasInstanceStates() to see if a value was sent in this field.
    
    Returns:
    
    A list of instance states that will filter the instances returned with this request.
  - marker
```
public final String marker()
```
    The pagination token that indicates the next set of results to retrieve.
    
    Returns:
    
    The pagination token that indicates the next set of results to retrieve.
  - toBuilder
```
public ListInstancesRequest.Builder 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 interface ToCopyableBuilder<ListInstancesRequest.Builder,ListInstancesRequest>
    
    Specified by:
    
    toBuilder in class EmrRequest
    
    Returns:
    
    a builder for type T
  - 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)
```
    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 an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    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
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.16.42

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

clusterId

instanceGroupId

instanceGroupTypes

hasInstanceGroupTypes

instanceGroupTypesAsStrings

instanceFleetId

instanceFleetType

instanceFleetTypeAsString

instanceStates

hasInstanceStates

instanceStatesAsStrings

marker

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields