Class FleetAttributes
- All Implemented Interfaces:
Serializable
,Cloneable
General properties describing a fleet.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Unique identifier for a build.Time stamp indicating when this object was created.Human-readable description of the fleet.Unique identifier for a fleet.Path to game-session log files generated by your game server.getName()
Descriptive label associated with this fleet.Type of game session protection to set for all new instances started in the fleet.Parameters required to launch your game server.Path to the launch executable for the game server.Current status of the fleet.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
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
Current status of the fleet.void
setTerminationTime
(Date terminationTime) Time stamp indicating when this fleet was terminated.toString()
Returns a string representation of this object; useful for testing and debugging.withBuildId
(String buildId) Unique identifier for a build.withCreationTime
(Date creationTime) Time stamp indicating when this object was created.withDescription
(String description) Human-readable description of the fleet.withFleetId
(String fleetId) Unique identifier for a fleet.withLogPaths
(String... logPaths) Path to game-session log files generated by your game server.withLogPaths
(Collection<String> logPaths) Path to game-session log files generated by your game server.Descriptive label associated with this fleet.withNewGameSessionProtectionPolicy
(ProtectionPolicy newGameSessionProtectionPolicy) Type of game session protection to set for all new instances started in the fleet.withNewGameSessionProtectionPolicy
(String newGameSessionProtectionPolicy) Type of game session protection to set for all new instances started in the fleet.withServerLaunchParameters
(String serverLaunchParameters) Parameters required to launch your game server.withServerLaunchPath
(String serverLaunchPath) Path to the launch executable for the game server.withStatus
(FleetStatus status) Current status of the fleet.withStatus
(String status) Current status of the fleet.withTerminationTime
(Date terminationTime) Time stamp indicating when this fleet was terminated.
-
Constructor Details
-
FleetAttributes
public FleetAttributes()
-
-
Method Details
-
setFleetId
Unique identifier for a fleet.
- Parameters:
fleetId
- Unique identifier for a fleet.
-
getFleetId
Unique identifier for a fleet.
- Returns:
- Unique identifier for a fleet.
-
withFleetId
Unique identifier for a fleet.
- Parameters:
fleetId
- Unique identifier for a fleet.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
Human-readable description of the fleet.
- Parameters:
description
- Human-readable description of the fleet.
-
getDescription
Human-readable description of the fleet.
- Returns:
- Human-readable description of the fleet.
-
withDescription
Human-readable description of the fleet.
- Parameters:
description
- Human-readable description of the fleet.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
Descriptive label associated with this fleet. Fleet names do not need to be unique.
- Parameters:
name
- Descriptive label associated with this fleet. Fleet names do not need to be unique.
-
getName
Descriptive label associated with this fleet. Fleet names do not need to be unique.
- Returns:
- Descriptive label associated with this fleet. Fleet names do not need to be unique.
-
withName
Descriptive label associated with this fleet. Fleet names do not need to be unique.
- Parameters:
name
- Descriptive label associated with this fleet. Fleet names do not need to be unique.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCreationTime
Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
- Parameters:
creationTime
- Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
-
getCreationTime
Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
- Returns:
- Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
-
withCreationTime
Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
- Parameters:
creationTime
- Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTerminationTime
Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
- Parameters:
terminationTime
- Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
-
getTerminationTime
Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
- Returns:
- Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
-
withTerminationTime
Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
- Parameters:
terminationTime
- Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatus
Current status of the fleet. Possible fleet states include:
- NEW: A new fleet has been defined and hosts allocated.
- DOWNLOADING/VALIDATING/BUILDING/ACTIVATING: The new fleet is being set up with the game build, and new hosts are being started.
- ACTIVE: Hosts can now accept game sessions.
- ERROR: An error occurred when downloading, validating, building, or activating the fleet.
- DELETING: Hosts are responding to a delete fleet request.
- TERMINATED: The fleet no longer exists.
- Parameters:
status
- Current status of the fleet. Possible fleet states include:- NEW: A new fleet has been defined and hosts allocated.
- DOWNLOADING/VALIDATING/BUILDING/ACTIVATING: The new fleet is being set up with the game build, and new hosts are being started.
- ACTIVE: Hosts can now accept game sessions.
- ERROR: An error occurred when downloading, validating, building, or activating the fleet.
- DELETING: Hosts are responding to a delete fleet request.
- TERMINATED: The fleet no longer exists.
- See Also:
-
getStatus
Current status of the fleet. Possible fleet states include:
- NEW: A new fleet has been defined and hosts allocated.
- DOWNLOADING/VALIDATING/BUILDING/ACTIVATING: The new fleet is being set up with the game build, and new hosts are being started.
- ACTIVE: Hosts can now accept game sessions.
- ERROR: An error occurred when downloading, validating, building, or activating the fleet.
- DELETING: Hosts are responding to a delete fleet request.
- TERMINATED: The fleet no longer exists.
- Returns:
- Current status of the fleet. Possible fleet states include:
- NEW: A new fleet has been defined and hosts allocated.
- DOWNLOADING/VALIDATING/BUILDING/ACTIVATING: The new fleet is being set up with the game build, and new hosts are being started.
- ACTIVE: Hosts can now accept game sessions.
- ERROR: An error occurred when downloading, validating, building, or activating the fleet.
- DELETING: Hosts are responding to a delete fleet request.
- TERMINATED: The fleet no longer exists.
- See Also:
-
withStatus
Current status of the fleet. Possible fleet states include:
- NEW: A new fleet has been defined and hosts allocated.
- DOWNLOADING/VALIDATING/BUILDING/ACTIVATING: The new fleet is being set up with the game build, and new hosts are being started.
- ACTIVE: Hosts can now accept game sessions.
- ERROR: An error occurred when downloading, validating, building, or activating the fleet.
- DELETING: Hosts are responding to a delete fleet request.
- TERMINATED: The fleet no longer exists.
- Parameters:
status
- Current status of the fleet. Possible fleet states include:- NEW: A new fleet has been defined and hosts allocated.
- DOWNLOADING/VALIDATING/BUILDING/ACTIVATING: The new fleet is being set up with the game build, and new hosts are being started.
- ACTIVE: Hosts can now accept game sessions.
- ERROR: An error occurred when downloading, validating, building, or activating the fleet.
- DELETING: Hosts are responding to a delete fleet request.
- TERMINATED: The fleet no longer exists.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setStatus
Current status of the fleet. Possible fleet states include:
- NEW: A new fleet has been defined and hosts allocated.
- DOWNLOADING/VALIDATING/BUILDING/ACTIVATING: The new fleet is being set up with the game build, and new hosts are being started.
- ACTIVE: Hosts can now accept game sessions.
- ERROR: An error occurred when downloading, validating, building, or activating the fleet.
- DELETING: Hosts are responding to a delete fleet request.
- TERMINATED: The fleet no longer exists.
- Parameters:
status
- Current status of the fleet. Possible fleet states include:- NEW: A new fleet has been defined and hosts allocated.
- DOWNLOADING/VALIDATING/BUILDING/ACTIVATING: The new fleet is being set up with the game build, and new hosts are being started.
- ACTIVE: Hosts can now accept game sessions.
- ERROR: An error occurred when downloading, validating, building, or activating the fleet.
- DELETING: Hosts are responding to a delete fleet request.
- TERMINATED: The fleet no longer exists.
- See Also:
-
withStatus
Current status of the fleet. Possible fleet states include:
- NEW: A new fleet has been defined and hosts allocated.
- DOWNLOADING/VALIDATING/BUILDING/ACTIVATING: The new fleet is being set up with the game build, and new hosts are being started.
- ACTIVE: Hosts can now accept game sessions.
- ERROR: An error occurred when downloading, validating, building, or activating the fleet.
- DELETING: Hosts are responding to a delete fleet request.
- TERMINATED: The fleet no longer exists.
- Parameters:
status
- Current status of the fleet. Possible fleet states include:- NEW: A new fleet has been defined and hosts allocated.
- DOWNLOADING/VALIDATING/BUILDING/ACTIVATING: The new fleet is being set up with the game build, and new hosts are being started.
- ACTIVE: Hosts can now accept game sessions.
- ERROR: An error occurred when downloading, validating, building, or activating the fleet.
- DELETING: Hosts are responding to a delete fleet request.
- TERMINATED: The fleet no longer exists.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setBuildId
Unique identifier for a build.
- Parameters:
buildId
- Unique identifier for a build.
-
getBuildId
Unique identifier for a build.
- Returns:
- Unique identifier for a build.
-
withBuildId
Unique identifier for a build.
- Parameters:
buildId
- Unique identifier for a build.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setServerLaunchPath
Path to the launch executable for the game server. A game server is built into a
C:\game
drive. This value must be expressed asC:\game\[launchpath]
. Example: If, when built, your game server files are in a folder called "MyGame", your log path should beC:\game\MyGame\server.exe
.- Parameters:
serverLaunchPath
- Path to the launch executable for the game server. A game server is built into aC:\game
drive. This value must be expressed asC:\game\[launchpath]
. Example: If, when built, your game server files are in a folder called "MyGame", your log path should beC:\game\MyGame\server.exe
.
-
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 asC:\game\[launchpath]
. Example: If, when built, your game server files are in a folder called "MyGame", your log path should beC:\game\MyGame\server.exe
.- Returns:
- Path to the launch executable for the game server. A game server
is built into a
C:\game
drive. This value must be expressed asC:\game\[launchpath]
. Example: If, when built, your game server files are in a folder called "MyGame", your log path should beC:\game\MyGame\server.exe
.
-
withServerLaunchPath
Path to the launch executable for the game server. A game server is built into a
C:\game
drive. This value must be expressed asC:\game\[launchpath]
. Example: If, when built, your game server files are in a folder called "MyGame", your log path should beC:\game\MyGame\server.exe
.- Parameters:
serverLaunchPath
- Path to the launch executable for the game server. A game server is built into aC:\game
drive. This value must be expressed asC:\game\[launchpath]
. Example: If, when built, your game server files are in a folder called "MyGame", your log path should beC:\game\MyGame\server.exe
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setServerLaunchParameters
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".
- Parameters:
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".
-
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".
- Returns:
- 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".
-
withServerLaunchParameters
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".
- Parameters:
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".- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Returns:
- 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.
-
setLogPaths
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.
- Parameters:
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.
-
withLogPaths
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)
orwithLogPaths(java.util.Collection)
if you want to override the existing values.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withLogPaths
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNewGameSessionProtectionPolicy
Type of game session protection to set for all new instances started in the fleet.
- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
- Parameters:
newGameSessionProtectionPolicy
- Type of game session protection to set for all new instances started in the fleet.- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
- See Also:
-
getNewGameSessionProtectionPolicy
Type of game session protection to set for all new instances started in the fleet.
- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
- Returns:
- Type of game session protection to set for all new instances
started in the fleet.
- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
- See Also:
-
withNewGameSessionProtectionPolicy
Type of game session protection to set for all new instances started in the fleet.
- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
- Parameters:
newGameSessionProtectionPolicy
- Type of game session protection to set for all new instances started in the fleet.- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setNewGameSessionProtectionPolicy
Type of game session protection to set for all new instances started in the fleet.
- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
- Parameters:
newGameSessionProtectionPolicy
- Type of game session protection to set for all new instances started in the fleet.- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
- See Also:
-
withNewGameSessionProtectionPolicy
public FleetAttributes withNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy) Type of game session protection to set for all new instances started in the fleet.
- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
- Parameters:
newGameSessionProtectionPolicy
- Type of game session protection to set for all new instances started in the fleet.- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-