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

Class RuntimeConfiguration

java.lang.Object

software.amazon.awssdk.services.gamelift.model.RuntimeConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RuntimeConfiguration.Builder,RuntimeConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class RuntimeConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RuntimeConfiguration.Builder,RuntimeConfiguration>

A collection of server process configurations that describe the set of processes to run on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. Amazon GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration.

A Amazon GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each server process. Learn more about Running Multiple Processes on a Fleet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RuntimeConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static RuntimeConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	gameSessionActivationTimeoutSeconds()	The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasServerProcesses()	For responses, this returns true if the service returned a value for the ServerProcesses property.
Integer	maxConcurrentGameSessionActivations()	The number of game sessions in status ACTIVATING to allow on an instance.
List<SdkField<?>>	sdkFields()
static Class<? extends RuntimeConfiguration.Builder>	serializableBuilderClass()
List<ServerProcess>	serverProcesses()	A collection of server process configurations that identify what server processes to run on each instance in a fleet.
RuntimeConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasServerProcesses

public final boolean hasServerProcesses()

For responses, this returns true if the service returned a value for the ServerProcesses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

serverProcesses

public final List<ServerProcess> serverProcesses()

A collection of server process configurations that identify what server processes to run on each instance in a fleet.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasServerProcesses() method.

Returns:

A collection of server process configurations that identify what server processes to run on each instance in a fleet.

maxConcurrentGameSessionActivations

public final Integer maxConcurrentGameSessionActivations()

The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.

Returns:

The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.

gameSessionActivationTimeoutSeconds

public final Integer gameSessionActivationTimeoutSeconds()

The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED.

Returns:

The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED.

toBuilder

public RuntimeConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuntimeConfiguration.Builder,RuntimeConfiguration>

builder

public static RuntimeConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends RuntimeConfiguration.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