Class ServerProcess

java.lang.Object
software.amazon.awssdk.services.gamelift.model.ServerProcess
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ServerProcess.Builder,ServerProcess>
@Generated("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 fleet computes. 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:

  • Method Details

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

      Returns:
      The number of server processes using this configuration that run concurrently on each instance or container..

    • toBuilder

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

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