Package software.amazon.awssdk.services.gamelift.model

Interface ListAliasesRequest.Builder

    • Method Detail

      • routingStrategyType

        ListAliasesRequest.Builder routingStrategyType​(String routingStrategyType)

        The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.

        Possible routing types include the following:

        • SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.

        • TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

        Parameters:
        routingStrategyType - The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.

        Possible routing types include the following:

        • SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.

        • TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RoutingStrategyType, RoutingStrategyType

      • routingStrategyType

        ListAliasesRequest.Builder routingStrategyType​(RoutingStrategyType routingStrategyType)

        The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.

        Possible routing types include the following:

        • SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.

        • TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

        Parameters:
        routingStrategyType - The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.

        Possible routing types include the following:

        • SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.

        • TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RoutingStrategyType, RoutingStrategyType

      • name

        ListAliasesRequest.Builder name​(String name)

        A descriptive label that is associated with an alias. Alias names do not need to be unique.

        Parameters:
        name - A descriptive label that is associated with an alias. Alias names do not need to be unique.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • limit

        ListAliasesRequest.Builder limit​(Integer limit)

        The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

        Parameters:
        limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListAliasesRequest.Builder nextToken​(String nextToken)

        A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

        Parameters:
        nextToken - A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.