DescribeInstanceStatusRequest (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class DescribeInstanceStatusRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeInstanceStatusRequest.Builder,DescribeInstanceStatusRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeInstanceStatusRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeInstanceStatusRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeInstanceStatusRequest.Builder`	`builder()`
`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()` When `true`, includes the health status for all instances.
`List<String>`	`instanceIds()` The 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()`
`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 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.
  - 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 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.
    
    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 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).
  - 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 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.
  - 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 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.
    
    Returns:
    
    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
```
public final String nextToken()
```
    The token to retrieve the next page of results.
    
    Returns:
    
    The token to retrieve the next page of results.
  - includeAllInstances
```
public final Boolean includeAllInstances()
```
    When true, includes the health status for all instances. When false, includes the health status for running instances only.
    
    Default: false
    
    Returns:
    
    When true, includes the health status for all instances. When false, includes the health status for running instances only.
    
    Default: false
  - toBuilder
```
public DescribeInstanceStatusRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeInstanceStatusRequest.Builder,DescribeInstanceStatusRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeInstanceStatusRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeInstanceStatusRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeInstanceStatusRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasFilters

filters

hasInstanceIds

instanceIds

maxResults

nextToken

includeAllInstances

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields