Interface ListServersRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListServersRequest.Builder,ListServersRequest>, MigrationHubStrategyRequest.Builder, SdkBuilder<ListServersRequest.Builder,ListServersRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListServersRequest
@Mutable @NotThreadSafe public static interface ListServersRequest.Builder extends MigrationHubStrategyRequest.Builder, SdkPojo, CopyableBuilder<ListServersRequest.Builder,ListServersRequest>

  • Method Details

    • filterValue

      ListServersRequest.Builder filterValue(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • groupIdFilter

      ListServersRequest.Builder groupIdFilter(Collection<Group> groupIdFilter)

      Specifies the group ID to filter on.

      Parameters:
      groupIdFilter - Specifies the group ID to filter on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupIdFilter

      ListServersRequest.Builder groupIdFilter(Group... groupIdFilter)

      Specifies the group ID to filter on.

      Parameters:
      groupIdFilter - Specifies the group ID to filter on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupIdFilter

      ListServersRequest.Builder groupIdFilter(Consumer<Group.Builder>... groupIdFilter)

      Specifies the group ID to filter on.

      This is a convenience method that creates an instance of the Group.Builder avoiding the need to create one manually via Group.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to groupIdFilter(List<Group>).

      Parameters:
      groupIdFilter - a consumer that will call methods on Group.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      ListServersRequest.Builder maxResults(Integer maxResults)

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

      Parameters:
      maxResults - The maximum number of items to include in the response. The maximum value is 100.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListServersRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • serverCriteria

      ListServersRequest.Builder serverCriteria(String serverCriteria)

      Criteria for filtering servers.

      Parameters:
      serverCriteria - Criteria for filtering servers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serverCriteria

      ListServersRequest.Builder serverCriteria(ServerCriteria serverCriteria)

      Criteria for filtering servers.

      Parameters:
      serverCriteria - Criteria for filtering servers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sort

      ListServersRequest.Builder sort(String sort)

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

      Parameters:
      sort - Specifies whether to sort by ascending (ASC) or descending (DESC) order.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sort

      ListServersRequest.Builder sort(SortOrder sort)

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

      Parameters:
      sort - Specifies whether to sort by ascending (ASC) or descending (DESC) order.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ListServersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListServersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.