Class ReportInstanceStatusRequest
- 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.ReportInstanceStatusRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ReportInstanceStatusRequest.Builder,ReportInstanceStatusRequest>
@Generated("software.amazon.awssdk:codegen") public final class ReportInstanceStatusRequest extends Ec2Request implements ToCopyableBuilder<ReportInstanceStatusRequest.Builder,ReportInstanceStatusRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ReportInstanceStatusRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ReportInstanceStatusRequest.Builder
builder()
String
description()
Descriptive text about the health state of your instance.Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.Instant
endTime()
The time at which the reported instance health state ended.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasInstances()
For responses, this returns true if the service returned a value for the Instances property.boolean
hasReasonCodes()
For responses, this returns true if the service returned a value for the ReasonCodes property.List<String>
instances()
The instances.List<ReportInstanceReasonCodes>
reasonCodes()
The reason codes that describe the health state of your instance.List<String>
reasonCodesAsStrings()
The reason codes that describe the health state of your instance.List<SdkField<?>>
sdkFields()
static Class<? extends ReportInstanceStatusRequest.Builder>
serializableBuilderClass()
Instant
startTime()
The time at which the reported instance health state began.ReportStatusType
status()
The status of all instances listed.String
statusAsString()
The status of all instances listed.ReportInstanceStatusRequest.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
-
description
public final String description()
Descriptive text about the health state of your instance.
- Returns:
- Descriptive text about the health state of your instance.
-
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
.
-
endTime
public final Instant endTime()
The time at which the reported instance health state ended.
- Returns:
- The time at which the reported instance health state ended.
-
hasInstances
public final boolean hasInstances()
For responses, this returns true if the service returned a value for the Instances 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.
-
instances
public final List<String> instances()
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
hasInstances()
method.- Returns:
- The instances.
-
reasonCodes
public final List<ReportInstanceReasonCodes> reasonCodes()
The reason codes that describe the health state of your instance.
-
instance-stuck-in-state
: My instance is stuck in a state. -
unresponsive
: My instance is unresponsive. -
not-accepting-credentials
: My instance is not accepting my credentials. -
password-not-available
: A password is not available for my instance. -
performance-network
: My instance is experiencing performance problems that I believe are network related. -
performance-instance-store
: My instance is experiencing performance problems that I believe are related to the instance stores. -
performance-ebs-volume
: My instance is experiencing performance problems that I believe are related to an EBS volume. -
performance-other
: My instance is experiencing performance problems. -
other
: [explain using the description parameter]
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
hasReasonCodes()
method.- Returns:
- The reason codes that describe the health state of your instance.
-
instance-stuck-in-state
: My instance is stuck in a state. -
unresponsive
: My instance is unresponsive. -
not-accepting-credentials
: My instance is not accepting my credentials. -
password-not-available
: A password is not available for my instance. -
performance-network
: My instance is experiencing performance problems that I believe are network related. -
performance-instance-store
: My instance is experiencing performance problems that I believe are related to the instance stores. -
performance-ebs-volume
: My instance is experiencing performance problems that I believe are related to an EBS volume. -
performance-other
: My instance is experiencing performance problems. -
other
: [explain using the description parameter]
-
-
-
hasReasonCodes
public final boolean hasReasonCodes()
For responses, this returns true if the service returned a value for the ReasonCodes 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.
-
reasonCodesAsStrings
public final List<String> reasonCodesAsStrings()
The reason codes that describe the health state of your instance.
-
instance-stuck-in-state
: My instance is stuck in a state. -
unresponsive
: My instance is unresponsive. -
not-accepting-credentials
: My instance is not accepting my credentials. -
password-not-available
: A password is not available for my instance. -
performance-network
: My instance is experiencing performance problems that I believe are network related. -
performance-instance-store
: My instance is experiencing performance problems that I believe are related to the instance stores. -
performance-ebs-volume
: My instance is experiencing performance problems that I believe are related to an EBS volume. -
performance-other
: My instance is experiencing performance problems. -
other
: [explain using the description parameter]
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
hasReasonCodes()
method.- Returns:
- The reason codes that describe the health state of your instance.
-
instance-stuck-in-state
: My instance is stuck in a state. -
unresponsive
: My instance is unresponsive. -
not-accepting-credentials
: My instance is not accepting my credentials. -
password-not-available
: A password is not available for my instance. -
performance-network
: My instance is experiencing performance problems that I believe are network related. -
performance-instance-store
: My instance is experiencing performance problems that I believe are related to the instance stores. -
performance-ebs-volume
: My instance is experiencing performance problems that I believe are related to an EBS volume. -
performance-other
: My instance is experiencing performance problems. -
other
: [explain using the description parameter]
-
-
-
startTime
public final Instant startTime()
The time at which the reported instance health state began.
- Returns:
- The time at which the reported instance health state began.
-
status
public final ReportStatusType status()
The status of all instances listed.
If the service returns an enum value that is not available in the current SDK version,
status
will returnReportStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of all instances listed.
- See Also:
ReportStatusType
-
statusAsString
public final String statusAsString()
The status of all instances listed.
If the service returns an enum value that is not available in the current SDK version,
status
will returnReportStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of all instances listed.
- See Also:
ReportStatusType
-
toBuilder
public ReportInstanceStatusRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ReportInstanceStatusRequest.Builder,ReportInstanceStatusRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static ReportInstanceStatusRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ReportInstanceStatusRequest.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
-
-