@Generated(value="com.amazonaws:aws-java-sdk-code-generator") 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 data object was created.
|
String |
getDescription()
Human-readable description of the fleet.
|
String |
getFleetId()
Unique identifier for a fleet.
|
List<String> |
getLogPaths()
Location of default log files.
|
String |
getName()
Descriptive label associated with a fleet.
|
String |
getNewGameSessionProtectionPolicy()
Type of game session protection to set for all new instances started in the fleet.
|
String |
getOperatingSystem()
Operating system of the fleet's computing resources.
|
ResourceCreationLimitPolicy |
getResourceCreationLimitPolicy()
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
|
String |
getServerLaunchParameters()
Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v.
|
String |
getServerLaunchPath()
Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04 (or AWS
SDK v.
|
String |
getStatus()
Current status of the fleet.
|
Date |
getTerminationTime()
Time stamp indicating when this data object was terminated.
|
int |
hashCode() |
void |
setBuildId(String buildId)
Unique identifier for a build.
|
void |
setCreationTime(Date creationTime)
Time stamp indicating when this data 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)
Location of default log files.
|
void |
setName(String name)
Descriptive label associated with a 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 |
setOperatingSystem(OperatingSystem operatingSystem)
Operating system of the fleet's computing resources.
|
void |
setOperatingSystem(String operatingSystem)
Operating system of the fleet's computing resources.
|
void |
setResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
|
void |
setServerLaunchParameters(String serverLaunchParameters)
Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v.
|
void |
setServerLaunchPath(String serverLaunchPath)
Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04 (or AWS
SDK v.
|
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 data object 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 data 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)
Location of default log files.
|
FleetAttributes |
withLogPaths(String... logPaths)
Location of default log files.
|
FleetAttributes |
withName(String name)
Descriptive label associated with a 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 |
withOperatingSystem(OperatingSystem operatingSystem)
Operating system of the fleet's computing resources.
|
FleetAttributes |
withOperatingSystem(String operatingSystem)
Operating system of the fleet's computing resources.
|
FleetAttributes |
withResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
|
FleetAttributes |
withServerLaunchParameters(String serverLaunchParameters)
Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v.
|
FleetAttributes |
withServerLaunchPath(String serverLaunchPath)
Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04 (or AWS
SDK v.
|
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 data object 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 a fleet. Fleet names do not need to be unique.
name
- Descriptive label associated with a fleet. Fleet names do not need to be unique.public String getName()
Descriptive label associated with a fleet. Fleet names do not need to be unique.
public FleetAttributes withName(String name)
Descriptive label associated with a fleet. Fleet names do not need to be unique.
name
- Descriptive label associated with a fleet. Fleet names do not need to be unique.public void setCreationTime(Date creationTime)
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").
creationTime
- Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
milliseconds (ex: "1469498468.057").public Date getCreationTime()
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").
public FleetAttributes withCreationTime(Date creationTime)
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").
creationTime
- Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
milliseconds (ex: "1469498468.057").public void setTerminationTime(Date terminationTime)
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").
terminationTime
- Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
milliseconds (ex: "1469498468.057").public Date getTerminationTime()
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").
public FleetAttributes withTerminationTime(Date terminationTime)
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").
terminationTime
- Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
milliseconds (ex: "1469498468.057").public void setStatus(String status)
Current status of the fleet.
Possible fleet statuses include the following:
NEW – A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.
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.
status
- Current status of the fleet.
Possible fleet statuses include the following:
NEW – A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.
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.
FleetStatus
public String getStatus()
Current status of the fleet.
Possible fleet statuses include the following:
NEW – A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.
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.
Possible fleet statuses include the following:
NEW – A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.
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.
FleetStatus
public FleetAttributes withStatus(String status)
Current status of the fleet.
Possible fleet statuses include the following:
NEW – A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.
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.
status
- Current status of the fleet.
Possible fleet statuses include the following:
NEW – A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.
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.
FleetStatus
public void setStatus(FleetStatus status)
Current status of the fleet.
Possible fleet statuses include the following:
NEW – A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.
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.
status
- Current status of the fleet.
Possible fleet statuses include the following:
NEW – A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.
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.
FleetStatus
public FleetAttributes withStatus(FleetStatus status)
Current status of the fleet.
Possible fleet statuses include the following:
NEW – A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.
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.
status
- Current status of the fleet.
Possible fleet statuses include the following:
NEW – A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.
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.
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 a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04 (or AWS
SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's
RuntimeConfiguration
.
serverLaunchPath
- Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04
(or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the
fleet's RuntimeConfiguration
.public String getServerLaunchPath()
Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04 (or AWS
SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's
RuntimeConfiguration
.
RuntimeConfiguration
.public FleetAttributes withServerLaunchPath(String serverLaunchPath)
Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04 (or AWS
SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's
RuntimeConfiguration
.
serverLaunchPath
- Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04
(or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the
fleet's RuntimeConfiguration
.public void setServerLaunchParameters(String serverLaunchParameters)
Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server
launch parameters for fleets created after this date are specified in the fleet's
RuntimeConfiguration
.
serverLaunchParameters
- Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16).
Server launch parameters for fleets created after this date are specified in the fleet's
RuntimeConfiguration
.public String getServerLaunchParameters()
Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server
launch parameters for fleets created after this date are specified in the fleet's
RuntimeConfiguration
.
RuntimeConfiguration
.public FleetAttributes withServerLaunchParameters(String serverLaunchParameters)
Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server
launch parameters for fleets created after this date are specified in the fleet's
RuntimeConfiguration
.
serverLaunchParameters
- Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16).
Server launch parameters for fleets created after this date are specified in the fleet's
RuntimeConfiguration
.public List<String> getLogPaths()
Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log
files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will
automatically upload logs that are stored on each instance at C:\game\logs
(for Windows) or
/local/game/logs
(for Linux). Use the GameLift console to access stored logs.
C:\game\logs
(for Windows) or
/local/game/logs
(for Linux). Use the GameLift console to access stored logs.public void setLogPaths(Collection<String> logPaths)
Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log
files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will
automatically upload logs that are stored on each instance at C:\game\logs
(for Windows) or
/local/game/logs
(for Linux). Use the GameLift console to access stored logs.
logPaths
- Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any
log files in this location. These logs are in addition to game session logs; see more on game session logs
in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will
automatically upload logs that are stored on each instance at C:\game\logs
(for Windows) or
/local/game/logs
(for Linux). Use the GameLift console to access stored logs.public FleetAttributes withLogPaths(String... logPaths)
Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log
files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will
automatically upload logs that are stored on each instance at C:\game\logs
(for Windows) or
/local/game/logs
(for Linux). Use the GameLift console to access 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
- Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any
log files in this location. These logs are in addition to game session logs; see more on game session logs
in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will
automatically upload logs that are stored on each instance at C:\game\logs
(for Windows) or
/local/game/logs
(for Linux). Use the GameLift console to access stored logs.public FleetAttributes withLogPaths(Collection<String> logPaths)
Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log
files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will
automatically upload logs that are stored on each instance at C:\game\logs
(for Windows) or
/local/game/logs
(for Linux). Use the GameLift console to access stored logs.
logPaths
- Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any
log files in this location. These logs are in addition to game session logs; see more on game session logs
in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will
automatically upload logs that are stored on each instance at C:\game\logs
(for Windows) or
/local/game/logs
(for Linux). Use the GameLift console to access stored logs.public void setNewGameSessionProtectionPolicy(String 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.
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.
ProtectionPolicy
public String 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.
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.
ProtectionPolicy
public FleetAttributes withNewGameSessionProtectionPolicy(String 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.
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.
ProtectionPolicy
public void setNewGameSessionProtectionPolicy(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.
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.
ProtectionPolicy
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.
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.
ProtectionPolicy
public void setOperatingSystem(String operatingSystem)
Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.
operatingSystem
- Operating system of the fleet's computing resources. A fleet's operating system depends on the OS
specified for the build that is deployed on this fleet.OperatingSystem
public String getOperatingSystem()
Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.
OperatingSystem
public FleetAttributes withOperatingSystem(String operatingSystem)
Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.
operatingSystem
- Operating system of the fleet's computing resources. A fleet's operating system depends on the OS
specified for the build that is deployed on this fleet.OperatingSystem
public void setOperatingSystem(OperatingSystem operatingSystem)
Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.
operatingSystem
- Operating system of the fleet's computing resources. A fleet's operating system depends on the OS
specified for the build that is deployed on this fleet.OperatingSystem
public FleetAttributes withOperatingSystem(OperatingSystem operatingSystem)
Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.
operatingSystem
- Operating system of the fleet's computing resources. A fleet's operating system depends on the OS
specified for the build that is deployed on this fleet.OperatingSystem
public void setResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
resourceCreationLimitPolicy
- Fleet policy to limit the number of game sessions an individual player can create over a span of time.public ResourceCreationLimitPolicy getResourceCreationLimitPolicy()
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
public FleetAttributes withResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
resourceCreationLimitPolicy
- Fleet policy to limit the number of game sessions an individual player can create over a span of time.public String toString()
toString
in class Object
Object.toString()
public FleetAttributes clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.