Class ListInstancesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListInstancesRequest.Builder,
ListInstancesRequest>
This input determines which instances to list.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListInstancesRequest.Builder
builder()
final String
The identifier of the cluster for which to list the instances.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InstanceGroupTypes property.final boolean
For responses, this returns true if the service returned a value for the InstanceStates property.final String
The unique identifier of the instance fleet.final InstanceFleetType
The node type of the instance fleet.final String
The node type of the instance fleet.final String
The identifier of the instance group for which to list the instances.final List
<InstanceGroupType> The type of instance group for which to list the instances.The type of instance group for which to list the instances.final List
<InstanceState> A list of instance states that will filter the instances returned with this request.A list of instance states that will filter the instances returned with this request.final String
marker()
The pagination token that indicates the next set of results to retrieve.static Class
<? extends ListInstancesRequest.Builder> 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
-
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
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
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 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. -
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
The unique identifier of the instance fleet.
- Returns:
- The unique identifier of the instance fleet.
-
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 returnInstanceFleetType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceFleetTypeAsString()
.- Returns:
- The node type of the instance fleet. For example MASTER, CORE, or TASK.
- See Also:
-
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 returnInstanceFleetType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceFleetTypeAsString()
.- Returns:
- The node type of the instance fleet. For example MASTER, CORE, or TASK.
- See Also:
-
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 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. -
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
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
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<ListInstancesRequest.Builder,
ListInstancesRequest> - Specified by:
toBuilder
in classEmrRequest
- 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
-