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(value="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

CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RoutingStrategy.Builder

Method Summary

Modifier and Type	Method and Description
static RoutingStrategy.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetId() A unique identifier for the fleet that the alias points to.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	message() The message text to be used with a terminal routing strategy.
List<SdkField<?>>	sdkFields()
static Class<? extends RoutingStrategy.Builder>	serializableBuilderClass()
RoutingStrategy.Builder	toBuilder()
String	toString() Returns a string representation of this object.
RoutingStrategyType	type() The type of routing strategy for the alias.
String	typeAsString() The type of routing strategy for the alias.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

See Also:

RoutingStrategyType

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

See Also:

RoutingStrategyType

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

Specified by:

toBuilder in interface ToCopyableBuilder<RoutingStrategy.Builder,RoutingStrategy>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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