software.amazon.awssdk.services.emr.model

Class ListInstancesRequest

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

Method Summary

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() For responses, this returns true if the service returned a value for the InstanceGroupTypes property.
boolean	hasInstanceStates() For responses, this returns true if the service returned a value for the InstanceStates property.
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.

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 hasInstanceGroupTypes() method.

Returns:

The type of instance group for which to list the instances.

hasInstanceGroupTypes

public final boolean hasInstanceGroupTypes()

For responses, this returns true if the service returned a value for the InstanceGroupTypes 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.

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.

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 hasInstanceGroupTypes() method.

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.

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 hasInstanceStates() method.

Returns:

A list of instance states that will filter the instances returned with this request.

hasInstanceStates

public final boolean hasInstanceStates()

For responses, this returns true if the service returned a value for the InstanceStates 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.

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.

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 hasInstanceStates() method.

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.