Class ListServersRequest

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

  • Method Details

    • filterValue

      public final String filterValue()

      Specifies the filter value, which is based on the type of server criteria. For example, if serverCriteria is OS_NAME, and the filterValue is equal to WindowsServer, then ListServers returns all of the servers matching the OS name WindowsServer.

      Returns:
      Specifies the filter value, which is based on the type of server criteria. For example, if serverCriteria is OS_NAME, and the filterValue is equal to WindowsServer, then ListServers returns all of the servers matching the OS name WindowsServer.

    • hasGroupIdFilter

      public final boolean hasGroupIdFilter()
      For responses, this returns true if the service returned a value for the GroupIdFilter 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.

    • groupIdFilter

      public final List<Group> groupIdFilter()

      Specifies the group ID to filter on.

      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 hasGroupIdFilter() method.

      Returns:
      Specifies the group ID to filter on.

    • maxResults

      public final Integer maxResults()

      The maximum number of items to include in the response. The maximum value is 100.

      Returns:
      The maximum number of items to include in the response. The maximum value is 100.

    • nextToken

      public final String nextToken()

      The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

      Returns:
      The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

    • serverCriteria

      public final ServerCriteria serverCriteria()

      Criteria for filtering servers.

      If the service returns an enum value that is not available in the current SDK version, serverCriteria will return ServerCriteria.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverCriteriaAsString().

      Returns:
      Criteria for filtering servers.
      See Also:

    • serverCriteriaAsString

      public final String serverCriteriaAsString()

      Criteria for filtering servers.

      If the service returns an enum value that is not available in the current SDK version, serverCriteria will return ServerCriteria.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverCriteriaAsString().

      Returns:
      Criteria for filtering servers.
      See Also:

    • sort

      public final SortOrder sort()

      Specifies whether to sort by ascending (ASC) or descending (DESC) order.

      If the service returns an enum value that is not available in the current SDK version, sort will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortAsString().

      Returns:
      Specifies whether to sort by ascending (ASC) or descending (DESC) order.
      See Also:

    • sortAsString

      public final String sortAsString()

      Specifies whether to sort by ascending (ASC) or descending (DESC) order.

      If the service returns an enum value that is not available in the current SDK version, sort will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortAsString().

      Returns:
      Specifies whether to sort by ascending (ASC) or descending (DESC) order.
      See Also:

    • toBuilder

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

    • builder

      public static ListServersRequest.Builder builder()

    • serializableBuilderClass

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