ServerProcess (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.gamelift.model.ServerProcess

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ServerProcess
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A set of instructions for launching server processes on each instance in a fleet. Server processes run either a custom game build executable or a Realtime Servers script. Each instruction set identifies the location of the custom game build executable or Realtime launch script, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration .

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ServerProcess()

Constructors
Constructor and Description
`ServerProcess()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServerProcess`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getConcurrentExecutions()` The number of server processes that use this configuration to run concurrently on an instance.
`String`	`getLaunchPath()` The location of the server executable in a custom game build or the name of the Realtime script file that contains the `Init()` function.
`String`	`getParameters()` An optional list of parameters to pass to the server executable or Realtime script on launch.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setConcurrentExecutions(Integer concurrentExecutions)` The number of server processes that use this configuration to run concurrently on an instance.
`void`	`setLaunchPath(String launchPath)` The location of the server executable in a custom game build or the name of the Realtime script file that contains the `Init()` function.
`void`	`setParameters(String parameters)` An optional list of parameters to pass to the server executable or Realtime script on launch.
`String`	`toString()` Returns a string representation of this object.
`ServerProcess`	`withConcurrentExecutions(Integer concurrentExecutions)` The number of server processes that use this configuration to run concurrently on an instance.
`ServerProcess`	`withLaunchPath(String launchPath)` The location of the server executable in a custom game build or the name of the Realtime script file that contains the `Init()` function.
`ServerProcess`	`withParameters(String parameters)` An optional list of parameters to pass to the server executable or Realtime script on launch.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ServerProcess
```
public ServerProcess()
```
- Method Detail
  - setLaunchPath
```
public void setLaunchPath(String launchPath)
```
    The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:
    - Windows (for 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"
    Parameters:
    launchPath - The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:
    
    Windows (for 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"
  - getLaunchPath
```
public String getLaunchPath()
```
    The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:
    - Windows (for 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"
    Returns:
    The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:
    
    Windows (for 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"
  - withLaunchPath
```
public ServerProcess withLaunchPath(String launchPath)
```
    The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:
    - Windows (for 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"
    Parameters:
    launchPath - The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:
    
    Windows (for 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"
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParameters
```
public void setParameters(String parameters)
```
    An optional list of parameters to pass to the server executable or Realtime script on launch.
    
    Parameters:
    
    parameters - An optional list of parameters to pass to the server executable or Realtime script on launch.
  - getParameters
```
public String getParameters()
```
    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.
  - withParameters
```
public ServerProcess withParameters(String parameters)
```
    An optional list of parameters to pass to the server executable or Realtime script on launch.
    
    Parameters:
    
    parameters - An optional list of parameters to pass to the server executable or Realtime script on launch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConcurrentExecutions
```
public void setConcurrentExecutions(Integer concurrentExecutions)
```
    The number of server processes that use this configuration to run concurrently on an instance.
    
    Parameters:
    
    concurrentExecutions - The number of server processes that use this configuration to run concurrently on an instance.
  - getConcurrentExecutions
```
public Integer getConcurrentExecutions()
```
    The number of server processes that use this configuration to run concurrently on an instance.
    
    Returns:
    
    The number of server processes that use this configuration to run concurrently on an instance.
  - withConcurrentExecutions
```
public ServerProcess withConcurrentExecutions(Integer concurrentExecutions)
```
    The number of server processes that use this configuration to run concurrently on an instance.
    
    Parameters:
    
    concurrentExecutions - The number of server processes that use this configuration to run concurrently on an instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ServerProcess clone()
```
    Overrides:
    
    clone in class Object
  - 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.

Did this page help you?

Class ServerProcess

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServerProcess

Method Detail

setLaunchPath

getLaunchPath

withLaunchPath

setParameters

getParameters

withParameters

setConcurrentExecutions

getConcurrentExecutions

withConcurrentExecutions

toString

equals

hashCode

clone

marshall