Class DescribeInstanceStatusRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.DescribeInstanceStatusRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeInstanceStatusRequest.Builder,DescribeInstanceStatusRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeInstanceStatusRequest extends Ec2Request implements ToCopyableBuilder<DescribeInstanceStatusRequest.Builder,DescribeInstanceStatusRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeInstanceStatusRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeInstanceStatusRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<Filter>
filters()
The filters.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
boolean
hasInstanceIds()
For responses, this returns true if the service returned a value for the InstanceIds property.Boolean
includeAllInstances()
Whentrue
, includes the health status for all instances.List<String>
instanceIds()
The instance IDs.Integer
maxResults()
The maximum number of items to return for this request.String
nextToken()
The token returned from a previous paginated request.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeInstanceStatusRequest.Builder>
serializableBuilderClass()
DescribeInstanceStatusRequest.Builder
toBuilder()
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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters 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.
-
filters
public final List<Filter> filters()
The 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.instance-event-id
- The ID of the event whose date and time you are modifying. -
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
). -
event.not-before-deadline
- The deadline for starting the 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 isreachability
(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 isreachability
(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.
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
hasFilters()
method.- Returns:
- The 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.instance-event-id
- The ID of the event whose date and time you are modifying. -
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
). -
event.not-before-deadline
- The deadline for starting the 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 isreachability
(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 isreachability
(passed
|failed
|initializing
|insufficient-data
). -
system-status.status
- The system status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
).
-
-
-
hasInstanceIds
public final boolean hasInstanceIds()
For responses, this returns true if the service returned a value for the InstanceIds 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.
-
instanceIds
public final List<String> instanceIds()
The 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.
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
hasInstanceIds()
method.- Returns:
- The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
-
maxResults
public final Integer maxResults()
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
- Returns:
- The maximum number of items to return for this request. To get the next page of items, make another
request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
-
nextToken
public final String nextToken()
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- Returns:
- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
includeAllInstances
public final Boolean includeAllInstances()
When
true
, includes the health status for all instances. Whenfalse
, includes the health status for running instances only.Default:
false
- Returns:
- When
true
, includes the health status for all instances. Whenfalse
, includes the health status for running instances only.Default:
false
-
toBuilder
public DescribeInstanceStatusRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeInstanceStatusRequest.Builder,DescribeInstanceStatusRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeInstanceStatusRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeInstanceStatusRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-