Class GetInstancesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lightsail.model.LightsailRequest
software.amazon.awssdk.services.lightsail.model.GetInstancesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetInstancesRequest.Builder,GetInstancesRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetInstancesRequest extends LightsailRequest implements ToCopyableBuilder<GetInstancesRequest.Builder,GetInstancesRequest>

  • Method Details

    • pageToken

      public final String pageToken()

      The token to advance to the next page of results from your request.

      To get a page token, perform an initial GetInstances request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

      Returns:
      The token to advance to the next page of results from your request.

      To get a page token, perform an initial GetInstances request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

    • includeHealthStatus

      public final Boolean includeHealthStatus()

      Specifies whether to include the instance health status checks of each instance in the response of your request.

      When set to true, the response includes the instanceStatus and systemStatus of each instance. When omitted or set to false, the response doesn't include them.

      Returns:
      Specifies whether to include the instance health status checks of each instance in the response of your request.

      When set to true, the response includes the instanceStatus and systemStatus of each instance. When omitted or set to false, the response doesn't include them.

    • toBuilder

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

    • builder

      public static GetInstancesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetInstancesRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.