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

Class RoutingStrategy

java.lang.Object
software.amazon.awssdk.services.gamelift.model.RoutingStrategy
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RoutingStrategy.Builder,RoutingStrategy>
@Generated("software.amazon.awssdk:codegen") public final class RoutingStrategy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RoutingStrategy.Builder,RoutingStrategy>

The routing configuration for a fleet alias.

Related actions

All APIs by task

See Also:

  • Method Details

    • type

      public final RoutingStrategyType type()

      The type of routing strategy for the alias.

      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 message embedded.

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

      Returns:
      The type of routing strategy for the alias.

      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 message embedded.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of routing strategy for the alias.

      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 message embedded.

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

      Returns:
      The type of routing strategy for the alias.

      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 message embedded.

      See Also:

    • fleetId

      public final String fleetId()

      A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.

      Returns:
      A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.

    • message

      public final String message()

      The message text to be used with a terminal routing strategy.

      Returns:
      The message text to be used with a terminal routing strategy.

    • toBuilder

      public RoutingStrategy.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<RoutingStrategy.Builder,RoutingStrategy>
      Returns:
      a builder for type T

    • builder

      public static RoutingStrategy.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RoutingStrategy.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

    • 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.