Class DescribeInstancesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeInstancesRequest.Builder,
DescribeInstancesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
fleetId()
A unique identifier for the fleet to retrieve instance information for.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 String
A unique identifier for an instance to retrieve.final Integer
limit()
The maximum number of results to return.final String
location()
The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such asus-west-2
.final String
A token that indicates the start of the next sequential page of results.static Class
<? extends DescribeInstancesRequest.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
-
fleetId
A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.
- Returns:
- A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.
-
instanceId
A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.
- Returns:
- A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.
-
limit
The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.- Returns:
- The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.
-
nextToken
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
- Returns:
- A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
-
location
The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as
us-west-2
.- Returns:
- The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region
code such as
us-west-2
.
-
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<DescribeInstancesRequest.Builder,
DescribeInstancesRequest> - Specified by:
toBuilder
in classGameLiftRequest
- 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
-