software.amazon.awssdk.services.gamelift.model

Class ServerProcess

java.lang.Object

software.amazon.awssdk.services.gamelift.model.ServerProcess

All Implemented Interfaces:

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

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

A set of instructions for launching server processes on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. Server process configurations are part of a fleet's runtime configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ServerProcess.Builder

Method Summary

Modifier and Type	Method and Description
static ServerProcess.Builder	builder()
Integer	concurrentExecutions() The number of server processes using this configuration that run concurrently on each instance.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	launchPath() The location of a game build executable or Realtime script.
String	parameters() An optional list of parameters to pass to the server executable or Realtime script on launch.
List<SdkField<?>>	sdkFields()
static Class<? extends ServerProcess.Builder>	serializableBuilderClass()
ServerProcess.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

launchPath

public final String launchPath()

The location of a game build executable or Realtime script. Game builds and Realtime scripts are installed on instances at the root:

• Windows (custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

• Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or " /local/game/MyRealtimeScript.js"

Amazon GameLift doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations initSDK() and ProcessReady().

Returns:

The location of a game build executable or Realtime script. Game builds and Realtime scripts are installed on instances at the root:

• Windows (custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe "

• Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or " /local/game/MyRealtimeScript.js"

Amazon GameLift doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations initSDK() and ProcessReady().

parameters

public final String parameters()

An optional list of parameters to pass to the server executable or Realtime script on launch.

Returns:

An optional list of parameters to pass to the server executable or Realtime script on launch.

concurrentExecutions

public final Integer concurrentExecutions()

The number of server processes using this configuration that run concurrently on each instance.

Returns:

The number of server processes using this configuration that run concurrently on each instance.

toBuilder

public ServerProcess.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ServerProcess.Builder,ServerProcess>

builder

public static ServerProcess.Builder builder()

serializableBuilderClass

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