Class ListAliasesRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.gamelift.model.ListAliasesRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class ListAliasesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Represents the input for a request action.

See Also:
  • Constructor Details

    • ListAliasesRequest

      public ListAliasesRequest()
  • Method Details

    • setRoutingStrategyType

      public void setRoutingStrategyType(String routingStrategyType)

      Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include:

      • 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 - Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include:
      • 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.
      See Also:
    • getRoutingStrategyType

      public String getRoutingStrategyType()

      Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include:

      • 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:
      Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include:
      • 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.
      See Also:
    • withRoutingStrategyType

      public ListAliasesRequest withRoutingStrategyType(String routingStrategyType)

      Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include:

      • 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 - Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include:
      • 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:
    • setRoutingStrategyType

      public void setRoutingStrategyType(RoutingStrategyType routingStrategyType)

      Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include:

      • 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 - Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include:
      • 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.
      See Also:
    • withRoutingStrategyType

      public ListAliasesRequest withRoutingStrategyType(RoutingStrategyType routingStrategyType)

      Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include:

      • 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 - Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include:
      • 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:
    • setName

      public void setName(String name)

      Descriptive label associated with this alias. Alias names do not need to be unique.

      Parameters:
      name - Descriptive label associated with this alias. Alias names do not need to be unique.
    • getName

      public String getName()

      Descriptive label associated with this alias. Alias names do not need to be unique.

      Returns:
      Descriptive label associated with this alias. Alias names do not need to be unique.
    • withName

      public ListAliasesRequest withName(String name)

      Descriptive label associated with this alias. Alias names do not need to be unique.

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

      public void setLimit(Integer limit)

      Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.

      Parameters:
      limit - Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
    • getLimit

      public Integer getLimit()

      Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.

      Returns:
      Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
    • withLimit

      public ListAliasesRequest withLimit(Integer limit)

      Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.

      Parameters:
      limit - Maximum number of results to return. You can 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.
    • setNextToken

      public void setNextToken(String nextToken)

      Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.

      Parameters:
      nextToken - Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
    • getNextToken

      public String getNextToken()

      Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.

      Returns:
      Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
    • withNextToken

      public ListAliasesRequest withNextToken(String nextToken)

      Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.

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

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public ListAliasesRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: