Package software.amazon.awssdk.services.ec2.model

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>

  • Method Details

    • 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 is UnauthorizedOperation.

      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 is UnauthorizedOperation.

    • 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 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.

    • 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 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.

    • 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 return ReportStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of all instances listed.
      See Also:

    • 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 return ReportStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of all instances listed.
      See Also:

    • toBuilder

      public ReportInstanceStatusRequest.Builder 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 interface ToCopyableBuilder<ReportInstanceStatusRequest.Builder,ReportInstanceStatusRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static ReportInstanceStatusRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ReportInstanceStatusRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.