@Generated(value="software.amazon.awssdk:codegen") public final class DescribeInstanceStatusRequest extends Ec2Request implements ToCopyableBuilder<DescribeInstanceStatusRequest.Builder,DescribeInstanceStatusRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeInstanceStatusRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeInstanceStatusRequest.Builder |
builder() |
boolean |
equals(Object obj) |
List<Filter> |
filters()
One or more filters.
|
<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 |
includeAllInstances()
When
true , includes the health status for all instances. |
List<String> |
instanceIds()
One or more instance IDs.
|
Integer |
maxResults()
The maximum number of results to return in a single call.
|
String |
nextToken()
The token to retrieve the next page of results.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeInstanceStatusRequest.Builder> |
serializableBuilderClass() |
DescribeInstanceStatusRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public List<Filter> filters()
One or more filters.
availability-zone
- The Availability Zone of the instance.
event.code
- The code for the scheduled event (instance-reboot
|
system-reboot
| system-maintenance
| instance-retirement
|
instance-stop
).
event.description
- A description of the event.
event.not-after
- The latest end time for the scheduled event (for example,
2014-09-15T17:15:20.000Z
).
event.not-before
- The earliest start time for the scheduled event (for example,
2014-09-15T17:15:20.000Z
).
instance-state-code
- The code for the instance state, as a 16-bit unsigned integer. The high byte
is used for internal purposes and should be ignored. The low byte is set based on the state represented. The
valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name
- The state of the instance (pending
| running
|
shutting-down
| terminated
| stopping
| stopped
).
instance-status.reachability
- Filters on instance status where the name is
reachability
(passed
| failed
| initializing
|
insufficient-data
).
instance-status.status
- The status of the instance (ok
| impaired
|
initializing
| insufficient-data
| not-applicable
).
system-status.reachability
- Filters on system status where the name is reachability
(
passed
| failed
| initializing
| insufficient-data
).
system-status.status
- The system status of the instance (ok
| impaired
|
initializing
| insufficient-data
| not-applicable
).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
availability-zone
- The Availability Zone of the instance.
event.code
- The code for the scheduled event (instance-reboot
|
system-reboot
| system-maintenance
| instance-retirement
|
instance-stop
).
event.description
- A description of the event.
event.not-after
- The latest end time for the scheduled event (for example,
2014-09-15T17:15:20.000Z
).
event.not-before
- The earliest start time for the scheduled event (for example,
2014-09-15T17:15:20.000Z
).
instance-state-code
- The code for the instance state, as a 16-bit unsigned integer. The
high byte is used for internal purposes and should be ignored. The low byte is set based on the state
represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64
(stopping), and 80 (stopped).
instance-state-name
- The state of the instance (pending
| running
| shutting-down
| terminated
| stopping
| stopped
).
instance-status.reachability
- Filters on instance status where the name is
reachability
(passed
| failed
| initializing
|
insufficient-data
).
instance-status.status
- The status of the instance (ok
| impaired
| initializing
| insufficient-data
| not-applicable
).
system-status.reachability
- Filters on system status where the name is
reachability
(passed
| failed
| initializing
|
insufficient-data
).
system-status.status
- The system status of the instance (ok
|
impaired
| initializing
| insufficient-data
|
not-applicable
).
public List<String> instanceIds()
One or more instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
public Integer maxResults()
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value. This value can be between 5 and 1000. You cannot specify this
parameter and the instance IDs parameter in the same call.
NextToken
value. This value can be between 5 and 1000. You cannot
specify this parameter and the instance IDs parameter in the same call.public String nextToken()
The token to retrieve the next page of results.
public Boolean includeAllInstances()
When true
, includes the health status for all instances. When false
, includes the
health status for running instances only.
Default: false
true
, includes the health status for all instances. When false
, includes
the health status for running instances only.
Default: false
public DescribeInstanceStatusRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeInstanceStatusRequest.Builder,DescribeInstanceStatusRequest>
toBuilder
in class Ec2Request
public static DescribeInstanceStatusRequest.Builder builder()
public static Class<? extends DescribeInstanceStatusRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.