com.amazonaws.services.gamelift.model.ServerProcess Maven / Gradle / Ivy
Show all versions of aws-java-sdk-gamelift Show documentation
/*
* Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.gamelift.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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
* RuntimeConfiguration.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ServerProcess implements Serializable, Cloneable, StructuredPojo {
/**
*
* The location of a game build executable or the Realtime script file that contains the Init()
* function. 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"
*
*
*
*/
private String launchPath;
/**
*
* An optional list of parameters to pass to the server executable or Realtime script on launch.
*
*/
private String parameters;
/**
*
* The number of server processes using this configuration that run concurrently on each instance.
*
*/
private Integer concurrentExecutions;
/**
*
* The location of a game build executable or the Realtime script file that contains the Init()
* function. 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"
*
*
*
*
* @param launchPath
* The location of a game build executable or the Realtime script file that contains the Init()
* function. 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"
*
*
*/
public void setLaunchPath(String launchPath) {
this.launchPath = launchPath;
}
/**
*
* The location of a game build executable or the Realtime script file that contains the Init()
* function. 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"
*
*
*
*
* @return The location of a game build executable or the Realtime script file that contains the Init()
* function. 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"
*
*
*/
public String getLaunchPath() {
return this.launchPath;
}
/**
*
* The location of a game build executable or the Realtime script file that contains the Init()
* function. 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"
*
*
*
*
* @param launchPath
* The location of a game build executable or the Realtime script file that contains the Init()
* function. 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"
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServerProcess withLaunchPath(String launchPath) {
setLaunchPath(launchPath);
return this;
}
/**
*
* An optional list of parameters to pass to the server executable or Realtime script on launch.
*
*
* @param parameters
* An optional list of parameters to pass to the server executable or Realtime script on launch.
*/
public void setParameters(String parameters) {
this.parameters = parameters;
}
/**
*
* An optional list of parameters to pass to the server executable or Realtime script on launch.
*
*
* @return An optional list of parameters to pass to the server executable or Realtime script on launch.
*/
public String getParameters() {
return this.parameters;
}
/**
*
* An optional list of parameters to pass to the server executable or Realtime script on launch.
*
*
* @param parameters
* An optional list of parameters to pass to the server executable or Realtime script on launch.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServerProcess withParameters(String parameters) {
setParameters(parameters);
return this;
}
/**
*
* The number of server processes using this configuration that run concurrently on each instance.
*
*
* @param concurrentExecutions
* The number of server processes using this configuration that run concurrently on each instance.
*/
public void setConcurrentExecutions(Integer concurrentExecutions) {
this.concurrentExecutions = concurrentExecutions;
}
/**
*
* The number of server processes using this configuration that run concurrently on each instance.
*
*
* @return The number of server processes using this configuration that run concurrently on each instance.
*/
public Integer getConcurrentExecutions() {
return this.concurrentExecutions;
}
/**
*
* The number of server processes using this configuration that run concurrently on each instance.
*
*
* @param concurrentExecutions
* The number of server processes using this configuration that run concurrently on each instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServerProcess withConcurrentExecutions(Integer concurrentExecutions) {
setConcurrentExecutions(concurrentExecutions);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getLaunchPath() != null)
sb.append("LaunchPath: ").append(getLaunchPath()).append(",");
if (getParameters() != null)
sb.append("Parameters: ").append(getParameters()).append(",");
if (getConcurrentExecutions() != null)
sb.append("ConcurrentExecutions: ").append(getConcurrentExecutions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ServerProcess == false)
return false;
ServerProcess other = (ServerProcess) obj;
if (other.getLaunchPath() == null ^ this.getLaunchPath() == null)
return false;
if (other.getLaunchPath() != null && other.getLaunchPath().equals(this.getLaunchPath()) == false)
return false;
if (other.getParameters() == null ^ this.getParameters() == null)
return false;
if (other.getParameters() != null && other.getParameters().equals(this.getParameters()) == false)
return false;
if (other.getConcurrentExecutions() == null ^ this.getConcurrentExecutions() == null)
return false;
if (other.getConcurrentExecutions() != null && other.getConcurrentExecutions().equals(this.getConcurrentExecutions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getLaunchPath() == null) ? 0 : getLaunchPath().hashCode());
hashCode = prime * hashCode + ((getParameters() == null) ? 0 : getParameters().hashCode());
hashCode = prime * hashCode + ((getConcurrentExecutions() == null) ? 0 : getConcurrentExecutions().hashCode());
return hashCode;
}
@Override
public ServerProcess clone() {
try {
return (ServerProcess) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.gamelift.model.transform.ServerProcessMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}