public class FleetAttributes extends Object implements Serializable, Cloneable
General properties describing a fleet.
Constructor and Description |
---|
FleetAttributes() |
Modifier and Type | Method and Description |
---|---|
FleetAttributes |
clone() |
boolean |
equals(Object obj) |
String |
getBuildId()
Unique identifier for a build.
|
Date |
getCreationTime()
Time stamp indicating when this object was created.
|
String |
getDescription()
Human-readable description of the fleet.
|
String |
getFleetId()
Unique identifier for a fleet.
|
List<String> |
getLogPaths()
Path to game-session log files generated by your game server.
|
String |
getName()
Descriptive label associated with this fleet.
|
String |
getNewGameSessionProtectionPolicy()
Type of game session protection to set for all new instances started in
the fleet.
|
String |
getServerLaunchParameters()
Parameters required to launch your game server.
|
String |
getServerLaunchPath()
Path to the launch executable for the game server.
|
String |
getStatus()
Current status of the fleet.
|
Date |
getTerminationTime()
Time stamp indicating when this fleet was terminated.
|
int |
hashCode() |
void |
setBuildId(String buildId)
Unique identifier for a build.
|
void |
setCreationTime(Date creationTime)
Time stamp indicating when this object was created.
|
void |
setDescription(String description)
Human-readable description of the fleet.
|
void |
setFleetId(String fleetId)
Unique identifier for a fleet.
|
void |
setLogPaths(Collection<String> logPaths)
Path to game-session log files generated by your game server.
|
void |
setName(String name)
Descriptive label associated with this fleet.
|
void |
setNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)
Type of game session protection to set for all new instances started in
the fleet.
|
void |
setNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
Type of game session protection to set for all new instances started in
the fleet.
|
void |
setServerLaunchParameters(String serverLaunchParameters)
Parameters required to launch your game server.
|
void |
setServerLaunchPath(String serverLaunchPath)
Path to the launch executable for the game server.
|
void |
setStatus(FleetStatus status)
Current status of the fleet.
|
void |
setStatus(String status)
Current status of the fleet.
|
void |
setTerminationTime(Date terminationTime)
Time stamp indicating when this fleet was terminated.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
FleetAttributes |
withBuildId(String buildId)
Unique identifier for a build.
|
FleetAttributes |
withCreationTime(Date creationTime)
Time stamp indicating when this object was created.
|
FleetAttributes |
withDescription(String description)
Human-readable description of the fleet.
|
FleetAttributes |
withFleetId(String fleetId)
Unique identifier for a fleet.
|
FleetAttributes |
withLogPaths(Collection<String> logPaths)
Path to game-session log files generated by your game server.
|
FleetAttributes |
withLogPaths(String... logPaths)
Path to game-session log files generated by your game server.
|
FleetAttributes |
withName(String name)
Descriptive label associated with this fleet.
|
FleetAttributes |
withNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)
Type of game session protection to set for all new instances started in
the fleet.
|
FleetAttributes |
withNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
Type of game session protection to set for all new instances started in
the fleet.
|
FleetAttributes |
withServerLaunchParameters(String serverLaunchParameters)
Parameters required to launch your game server.
|
FleetAttributes |
withServerLaunchPath(String serverLaunchPath)
Path to the launch executable for the game server.
|
FleetAttributes |
withStatus(FleetStatus status)
Current status of the fleet.
|
FleetAttributes |
withStatus(String status)
Current status of the fleet.
|
FleetAttributes |
withTerminationTime(Date terminationTime)
Time stamp indicating when this fleet was terminated.
|
public void setFleetId(String fleetId)
Unique identifier for a fleet.
fleetId
- Unique identifier for a fleet.public String getFleetId()
Unique identifier for a fleet.
public FleetAttributes withFleetId(String fleetId)
Unique identifier for a fleet.
fleetId
- Unique identifier for a fleet.public void setDescription(String description)
Human-readable description of the fleet.
description
- Human-readable description of the fleet.public String getDescription()
Human-readable description of the fleet.
public FleetAttributes withDescription(String description)
Human-readable description of the fleet.
description
- Human-readable description of the fleet.public void setName(String name)
Descriptive label associated with this fleet. Fleet names do not need to be unique.
name
- Descriptive label associated with this fleet. Fleet names do not
need to be unique.public String getName()
Descriptive label associated with this fleet. Fleet names do not need to be unique.
public FleetAttributes withName(String name)
Descriptive label associated with this fleet. Fleet names do not need to be unique.
name
- Descriptive label associated with this fleet. Fleet names do not
need to be unique.public void setCreationTime(Date creationTime)
Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
creationTime
- Time stamp indicating when this object was created. Format is an
integer representing the number of seconds since the Unix epoch
(Unix time).public Date getCreationTime()
Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
public FleetAttributes withCreationTime(Date creationTime)
Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
creationTime
- Time stamp indicating when this object was created. Format is an
integer representing the number of seconds since the Unix epoch
(Unix time).public void setTerminationTime(Date terminationTime)
Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
terminationTime
- Time stamp indicating when this fleet was terminated. Format is an
integer representing the number of seconds since the Unix epoch
(Unix time).public Date getTerminationTime()
Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
public FleetAttributes withTerminationTime(Date terminationTime)
Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
terminationTime
- Time stamp indicating when this fleet was terminated. Format is an
integer representing the number of seconds since the Unix epoch
(Unix time).public void setStatus(String status)
Current status of the fleet. Possible fleet states include:
status
- Current status of the fleet. Possible fleet states include:
FleetStatus
public String getStatus()
Current status of the fleet. Possible fleet states include:
FleetStatus
public FleetAttributes withStatus(String status)
Current status of the fleet. Possible fleet states include:
status
- Current status of the fleet. Possible fleet states include:
FleetStatus
public void setStatus(FleetStatus status)
Current status of the fleet. Possible fleet states include:
status
- Current status of the fleet. Possible fleet states include:
FleetStatus
public FleetAttributes withStatus(FleetStatus status)
Current status of the fleet. Possible fleet states include:
status
- Current status of the fleet. Possible fleet states include:
FleetStatus
public void setBuildId(String buildId)
Unique identifier for a build.
buildId
- Unique identifier for a build.public String getBuildId()
Unique identifier for a build.
public FleetAttributes withBuildId(String buildId)
Unique identifier for a build.
buildId
- Unique identifier for a build.public void setServerLaunchPath(String serverLaunchPath)
Path to the launch executable for the game server. A game server is built
into a C:\game
drive. This value must be expressed as
C:\game\[launchpath]
. Example: If, when built, your game
server files are in a folder called "MyGame", your log path should be
C:\game\MyGame\server.exe
.
serverLaunchPath
- Path to the launch executable for the game server. A game server
is built into a C:\game
drive. This value must be
expressed as C:\game\[launchpath]
. Example: If, when
built, your game server files are in a folder called "MyGame",
your log path should be C:\game\MyGame\server.exe
.public String getServerLaunchPath()
Path to the launch executable for the game server. A game server is built
into a C:\game
drive. This value must be expressed as
C:\game\[launchpath]
. Example: If, when built, your game
server files are in a folder called "MyGame", your log path should be
C:\game\MyGame\server.exe
.
C:\game
drive. This value must be
expressed as C:\game\[launchpath]
. Example: If, when
built, your game server files are in a folder called "MyGame",
your log path should be C:\game\MyGame\server.exe
.public FleetAttributes withServerLaunchPath(String serverLaunchPath)
Path to the launch executable for the game server. A game server is built
into a C:\game
drive. This value must be expressed as
C:\game\[launchpath]
. Example: If, when built, your game
server files are in a folder called "MyGame", your log path should be
C:\game\MyGame\server.exe
.
serverLaunchPath
- Path to the launch executable for the game server. A game server
is built into a C:\game
drive. This value must be
expressed as C:\game\[launchpath]
. Example: If, when
built, your game server files are in a folder called "MyGame",
your log path should be C:\game\MyGame\server.exe
.public void setServerLaunchParameters(String serverLaunchParameters)
Parameters required to launch your game server. These parameters should be expressed as a string of command-line parameters. Example: "+sv_port 33435 +start_lobby".
serverLaunchParameters
- Parameters required to launch your game server. These parameters
should be expressed as a string of command-line parameters.
Example: "+sv_port 33435 +start_lobby".public String getServerLaunchParameters()
Parameters required to launch your game server. These parameters should be expressed as a string of command-line parameters. Example: "+sv_port 33435 +start_lobby".
public FleetAttributes withServerLaunchParameters(String serverLaunchParameters)
Parameters required to launch your game server. These parameters should be expressed as a string of command-line parameters. Example: "+sv_port 33435 +start_lobby".
serverLaunchParameters
- Parameters required to launch your game server. These parameters
should be expressed as a string of command-line parameters.
Example: "+sv_port 33435 +start_lobby".public List<String> getLogPaths()
Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.
public void setLogPaths(Collection<String> logPaths)
Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.
logPaths
- Path to game-session log files generated by your game server. Once
a game session has been terminated, Amazon GameLift captures and
stores the logs on Amazon S3. Use the GameLift console to access
the stored logs.public FleetAttributes withLogPaths(String... logPaths)
Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.
NOTE: This method appends the values to the existing list (if
any). Use setLogPaths(java.util.Collection)
or
withLogPaths(java.util.Collection)
if you want to override the
existing values.
logPaths
- Path to game-session log files generated by your game server. Once
a game session has been terminated, Amazon GameLift captures and
stores the logs on Amazon S3. Use the GameLift console to access
the stored logs.public FleetAttributes withLogPaths(Collection<String> logPaths)
Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.
logPaths
- Path to game-session log files generated by your game server. Once
a game session has been terminated, Amazon GameLift captures and
stores the logs on Amazon S3. Use the GameLift console to access
the stored logs.public void setNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
Type of game session protection to set for all new instances started in the fleet.
newGameSessionProtectionPolicy
- Type of game session protection to set for all new instances
started in the fleet.
ProtectionPolicy
public String getNewGameSessionProtectionPolicy()
Type of game session protection to set for all new instances started in the fleet.
ProtectionPolicy
public FleetAttributes withNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
Type of game session protection to set for all new instances started in the fleet.
newGameSessionProtectionPolicy
- Type of game session protection to set for all new instances
started in the fleet.
ProtectionPolicy
public void setNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)
Type of game session protection to set for all new instances started in the fleet.
newGameSessionProtectionPolicy
- Type of game session protection to set for all new instances
started in the fleet.
ProtectionPolicy
public FleetAttributes withNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)
Type of game session protection to set for all new instances started in the fleet.
newGameSessionProtectionPolicy
- Type of game session protection to set for all new instances
started in the fleet.
ProtectionPolicy
public String toString()
toString
in class Object
Object.toString()
public FleetAttributes clone()
Copyright © 2018. All rights reserved.