software.amazon.awssdk.services.gamelift.model

Class RoutingStrategy

java.lang.Object

software.amazon.awssdk.services.gamelift.model.RoutingStrategy

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<RoutingStrategy.Builder,RoutingStrategy>

@Generated(value="software.amazon.awssdk:codegen")
public class RoutingStrategy
extends Object
implements StructuredPojo, ToCopyableBuilder<RoutingStrategy.Builder,RoutingStrategy>

Routing configuration for a fleet alias.

Fleet-related operations include:

• CreateFleet

• ListFleets

• Describe fleets:

  • DescribeFleetAttributes

  • DescribeFleetPortSettings

  • DescribeFleetUtilization

  • DescribeRuntimeConfiguration

  • DescribeFleetEvents

• Update fleets:

  • UpdateFleetAttributes

  • UpdateFleetCapacity

  • UpdateFleetPortSettings

  • UpdateRuntimeConfiguration

• Manage fleet capacity:

  • DescribeFleetCapacity

  • UpdateFleetCapacity

  • PutScalingPolicy (automatic scaling)

  • DescribeScalingPolicies (automatic scaling)

  • DeleteScalingPolicy (automatic scaling)

  • DescribeEC2InstanceLimits

• DeleteFleet

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)
String	fleetId() Unique identifier for a fleet that the alias points to.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	message() Message text to be used with a terminal routing strategy.
static Class<? extends RoutingStrategy.Builder>	serializableBuilderClass()
RoutingStrategy.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
RoutingStrategyType	type() Type of routing strategy.
String	typeAsString() Type of routing strategy.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

type

public RoutingStrategyType type()

Type of routing strategy.

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:

Type of routing strategy.

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

Type of routing strategy.

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:

Type of routing strategy.

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

Unique identifier for a fleet that the alias points to.

Returns:

Unique identifier for a fleet that the alias points to.

message

public String message()

Message text to be used with a terminal routing strategy.

Returns:

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

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.