com.amazonaws.services.gamelift.model.FleetAttributes Maven / Gradle / Ivy
/*
* Copyright 2012-2018 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;
/**
*
* General properties describing a fleet.
*
*
* Fleet-related operations include:
*
*
* -
*
* CreateFleet
*
*
* -
*
* ListFleets
*
*
* -
*
* Describe fleets:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* -
*
* Update fleets:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* -
*
* Manage fleet capacity:
*
*
* -
*
*
* -
*
*
* -
*
* PutScalingPolicy (automatic scaling)
*
*
* -
*
* DescribeScalingPolicies (automatic scaling)
*
*
* -
*
* DeleteScalingPolicy (automatic scaling)
*
*
* -
*
*
*
*
* -
*
* DeleteFleet
*
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class FleetAttributes implements Serializable, Cloneable, StructuredPojo {
/**
*
* Unique identifier for a fleet.
*
*/
private String fleetId;
/**
*
* Identifier for a fleet that is unique across all regions.
*
*/
private String fleetArn;
/**
*
* Human-readable description of the fleet.
*
*/
private String description;
/**
*
* Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
*
*/
private String name;
/**
*
* Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
*
*/
private java.util.Date creationTime;
/**
*
* Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
*
*/
private java.util.Date terminationTime;
/**
*
* 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 -- Amazon 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.
*
*
*
*/
private String status;
/**
*
* Unique identifier for a build.
*
*/
private String buildId;
/**
*
* Path to a game server executable in the fleet's build, specified for fleets created before 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.
*
*/
private String serverLaunchPath;
/**
*
* Game server launch parameters specified for fleets created before 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.
*
*/
private String serverLaunchParameters;
/**
*
* 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, Amazon GameLift
* automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or
* /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
*
*/
private java.util.List logPaths;
/**
*
* 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.
*
*
*
*/
private String newGameSessionProtectionPolicy;
/**
*
* 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.
*
*/
private String operatingSystem;
/**
*
* Fleet policy to limit the number of game sessions an individual player can create over a span of time.
*
*/
private ResourceCreationLimitPolicy resourceCreationLimitPolicy;
/**
*
* Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an
* individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in
* only one metric group at a time.
*
*/
private java.util.List metricGroups;
/**
*
* Unique identifier for a fleet.
*
*
* @param fleetId
* Unique identifier for a fleet.
*/
public void setFleetId(String fleetId) {
this.fleetId = fleetId;
}
/**
*
* Unique identifier for a fleet.
*
*
* @return Unique identifier for a fleet.
*/
public String getFleetId() {
return this.fleetId;
}
/**
*
* Unique identifier for a fleet.
*
*
* @param fleetId
* Unique identifier for a fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withFleetId(String fleetId) {
setFleetId(fleetId);
return this;
}
/**
*
* Identifier for a fleet that is unique across all regions.
*
*
* @param fleetArn
* Identifier for a fleet that is unique across all regions.
*/
public void setFleetArn(String fleetArn) {
this.fleetArn = fleetArn;
}
/**
*
* Identifier for a fleet that is unique across all regions.
*
*
* @return Identifier for a fleet that is unique across all regions.
*/
public String getFleetArn() {
return this.fleetArn;
}
/**
*
* Identifier for a fleet that is unique across all regions.
*
*
* @param fleetArn
* Identifier for a fleet that is unique across all regions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withFleetArn(String fleetArn) {
setFleetArn(fleetArn);
return this;
}
/**
*
* Human-readable description of the fleet.
*
*
* @param description
* Human-readable description of the fleet.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* Human-readable description of the fleet.
*
*
* @return Human-readable description of the fleet.
*/
public String getDescription() {
return this.description;
}
/**
*
* Human-readable description of the fleet.
*
*
* @param description
* Human-readable description of the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
*
*
* @param name
* Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
*
*
* @return Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
*/
public String getName() {
return this.name;
}
/**
*
* Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
*
*
* @param name
* Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withName(String name) {
setName(name);
return this;
}
/**
*
* Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
*
*
* @param creationTime
* Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
*
*
* @return Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
*
*
* @param creationTime
* Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
*
*
* @param terminationTime
* Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
*/
public void setTerminationTime(java.util.Date terminationTime) {
this.terminationTime = terminationTime;
}
/**
*
* Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
*
*
* @return Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
*/
public java.util.Date getTerminationTime() {
return this.terminationTime;
}
/**
*
* Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
*
*
* @param terminationTime
* Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
* milliseconds (for example "1469498468.057").
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withTerminationTime(java.util.Date terminationTime) {
setTerminationTime(terminationTime);
return this;
}
/**
*
* 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 -- Amazon 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.
*
*
*
*
* @param 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 -- Amazon 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.
*
*
* @see FleetStatus
*/
public void setStatus(String status) {
this.status = 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 -- Amazon 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.
*
*
*
*
* @return 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 -- Amazon 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.
*
*
* @see FleetStatus
*/
public String getStatus() {
return this.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 -- Amazon 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.
*
*
*
*
* @param 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 -- Amazon 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see FleetStatus
*/
public FleetAttributes withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* 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 -- Amazon 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.
*
*
*
*
* @param 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 -- Amazon 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.
*
*
* @see FleetStatus
*/
public void setStatus(FleetStatus status) {
withStatus(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 -- Amazon 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.
*
*
*
*
* @param 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 -- Amazon 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see FleetStatus
*/
public FleetAttributes withStatus(FleetStatus status) {
this.status = status.toString();
return this;
}
/**
*
* Unique identifier for a build.
*
*
* @param buildId
* Unique identifier for a build.
*/
public void setBuildId(String buildId) {
this.buildId = buildId;
}
/**
*
* Unique identifier for a build.
*
*
* @return Unique identifier for a build.
*/
public String getBuildId() {
return this.buildId;
}
/**
*
* Unique identifier for a build.
*
*
* @param buildId
* Unique identifier for a build.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withBuildId(String buildId) {
setBuildId(buildId);
return this;
}
/**
*
* Path to a game server executable in the fleet's build, specified for fleets created before 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.
*
*
* @param serverLaunchPath
* Path to a game server executable in the fleet's build, specified for fleets created before 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 setServerLaunchPath(String serverLaunchPath) {
this.serverLaunchPath = serverLaunchPath;
}
/**
*
* Path to a game server executable in the fleet's build, specified for fleets created before 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.
*
*
* @return Path to a game server executable in the fleet's build, specified for fleets created before 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() {
return this.serverLaunchPath;
}
/**
*
* Path to a game server executable in the fleet's build, specified for fleets created before 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.
*
*
* @param serverLaunchPath
* Path to a game server executable in the fleet's build, specified for fleets created before 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withServerLaunchPath(String serverLaunchPath) {
setServerLaunchPath(serverLaunchPath);
return this;
}
/**
*
* Game server launch parameters specified for fleets created before 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.
*
*
* @param serverLaunchParameters
* Game server launch parameters specified for fleets created before 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 void setServerLaunchParameters(String serverLaunchParameters) {
this.serverLaunchParameters = serverLaunchParameters;
}
/**
*
* Game server launch parameters specified for fleets created before 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.
*
*
* @return Game server launch parameters specified for fleets created before 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() {
return this.serverLaunchParameters;
}
/**
*
* Game server launch parameters specified for fleets created before 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.
*
*
* @param serverLaunchParameters
* Game server launch parameters specified for fleets created before 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withServerLaunchParameters(String serverLaunchParameters) {
setServerLaunchParameters(serverLaunchParameters);
return this;
}
/**
*
* 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, Amazon GameLift
* automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or
* /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
*
*
* @return 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, Amazon GameLift
* automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or
* /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
*/
public java.util.List getLogPaths() {
return 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, Amazon GameLift
* automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or
* /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
*
*
* @param 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, Amazon GameLift
* automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or
* /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
*/
public void setLogPaths(java.util.Collection logPaths) {
if (logPaths == null) {
this.logPaths = null;
return;
}
this.logPaths = new java.util.ArrayList(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, Amazon GameLift
* automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or
* /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setLogPaths(java.util.Collection)} or {@link #withLogPaths(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param 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, Amazon GameLift
* automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or
* /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withLogPaths(String... logPaths) {
if (this.logPaths == null) {
setLogPaths(new java.util.ArrayList(logPaths.length));
}
for (String ele : logPaths) {
this.logPaths.add(ele);
}
return this;
}
/**
*
* 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, Amazon GameLift
* automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or
* /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
*
*
* @param 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, Amazon GameLift
* automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or
* /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withLogPaths(java.util.Collection logPaths) {
setLogPaths(logPaths);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 ProtectionPolicy
*/
public void setNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy) {
this.newGameSessionProtectionPolicy = 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.
*
*
*
*
* @return 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 ProtectionPolicy
*/
public String getNewGameSessionProtectionPolicy() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProtectionPolicy
*/
public FleetAttributes withNewGameSessionProtectionPolicy(String newGameSessionProtectionPolicy) {
setNewGameSessionProtectionPolicy(newGameSessionProtectionPolicy);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 ProtectionPolicy
*/
public void setNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy) {
withNewGameSessionProtectionPolicy(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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProtectionPolicy
*/
public FleetAttributes withNewGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy) {
this.newGameSessionProtectionPolicy = newGameSessionProtectionPolicy.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see OperatingSystem
*/
public void setOperatingSystem(String operatingSystem) {
this.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.
*
*
* @return 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.
* @see OperatingSystem
*/
public String getOperatingSystem() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OperatingSystem
*/
public FleetAttributes withOperatingSystem(String operatingSystem) {
setOperatingSystem(operatingSystem);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see OperatingSystem
*/
public void setOperatingSystem(OperatingSystem operatingSystem) {
withOperatingSystem(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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OperatingSystem
*/
public FleetAttributes withOperatingSystem(OperatingSystem operatingSystem) {
this.operatingSystem = operatingSystem.toString();
return this;
}
/**
*
* Fleet policy to limit the number of game sessions an individual player can create over a span of time.
*
*
* @param resourceCreationLimitPolicy
* Fleet policy to limit the number of game sessions an individual player can create over a span of time.
*/
public void setResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy) {
this.resourceCreationLimitPolicy = resourceCreationLimitPolicy;
}
/**
*
* Fleet policy to limit the number of game sessions an individual player can create over a span of time.
*
*
* @return Fleet policy to limit the number of game sessions an individual player can create over a span of time.
*/
public ResourceCreationLimitPolicy getResourceCreationLimitPolicy() {
return this.resourceCreationLimitPolicy;
}
/**
*
* Fleet policy to limit the number of game sessions an individual player can create over a span of time.
*
*
* @param resourceCreationLimitPolicy
* Fleet policy to limit the number of game sessions an individual player can create over a span of time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withResourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy) {
setResourceCreationLimitPolicy(resourceCreationLimitPolicy);
return this;
}
/**
*
* Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an
* individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in
* only one metric group at a time.
*
*
* @return Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an
* individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be
* included in only one metric group at a time.
*/
public java.util.List getMetricGroups() {
return metricGroups;
}
/**
*
* Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an
* individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in
* only one metric group at a time.
*
*
* @param metricGroups
* Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an
* individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be
* included in only one metric group at a time.
*/
public void setMetricGroups(java.util.Collection metricGroups) {
if (metricGroups == null) {
this.metricGroups = null;
return;
}
this.metricGroups = new java.util.ArrayList(metricGroups);
}
/**
*
* Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an
* individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in
* only one metric group at a time.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setMetricGroups(java.util.Collection)} or {@link #withMetricGroups(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param metricGroups
* Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an
* individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be
* included in only one metric group at a time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withMetricGroups(String... metricGroups) {
if (this.metricGroups == null) {
setMetricGroups(new java.util.ArrayList(metricGroups.length));
}
for (String ele : metricGroups) {
this.metricGroups.add(ele);
}
return this;
}
/**
*
* Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an
* individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in
* only one metric group at a time.
*
*
* @param metricGroups
* Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an
* individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be
* included in only one metric group at a time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FleetAttributes withMetricGroups(java.util.Collection metricGroups) {
setMetricGroups(metricGroups);
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFleetId() != null)
sb.append("FleetId: ").append(getFleetId()).append(",");
if (getFleetArn() != null)
sb.append("FleetArn: ").append(getFleetArn()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getTerminationTime() != null)
sb.append("TerminationTime: ").append(getTerminationTime()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getBuildId() != null)
sb.append("BuildId: ").append(getBuildId()).append(",");
if (getServerLaunchPath() != null)
sb.append("ServerLaunchPath: ").append(getServerLaunchPath()).append(",");
if (getServerLaunchParameters() != null)
sb.append("ServerLaunchParameters: ").append(getServerLaunchParameters()).append(",");
if (getLogPaths() != null)
sb.append("LogPaths: ").append(getLogPaths()).append(",");
if (getNewGameSessionProtectionPolicy() != null)
sb.append("NewGameSessionProtectionPolicy: ").append(getNewGameSessionProtectionPolicy()).append(",");
if (getOperatingSystem() != null)
sb.append("OperatingSystem: ").append(getOperatingSystem()).append(",");
if (getResourceCreationLimitPolicy() != null)
sb.append("ResourceCreationLimitPolicy: ").append(getResourceCreationLimitPolicy()).append(",");
if (getMetricGroups() != null)
sb.append("MetricGroups: ").append(getMetricGroups());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof FleetAttributes == false)
return false;
FleetAttributes other = (FleetAttributes) obj;
if (other.getFleetId() == null ^ this.getFleetId() == null)
return false;
if (other.getFleetId() != null && other.getFleetId().equals(this.getFleetId()) == false)
return false;
if (other.getFleetArn() == null ^ this.getFleetArn() == null)
return false;
if (other.getFleetArn() != null && other.getFleetArn().equals(this.getFleetArn()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getTerminationTime() == null ^ this.getTerminationTime() == null)
return false;
if (other.getTerminationTime() != null && other.getTerminationTime().equals(this.getTerminationTime()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getBuildId() == null ^ this.getBuildId() == null)
return false;
if (other.getBuildId() != null && other.getBuildId().equals(this.getBuildId()) == false)
return false;
if (other.getServerLaunchPath() == null ^ this.getServerLaunchPath() == null)
return false;
if (other.getServerLaunchPath() != null && other.getServerLaunchPath().equals(this.getServerLaunchPath()) == false)
return false;
if (other.getServerLaunchParameters() == null ^ this.getServerLaunchParameters() == null)
return false;
if (other.getServerLaunchParameters() != null && other.getServerLaunchParameters().equals(this.getServerLaunchParameters()) == false)
return false;
if (other.getLogPaths() == null ^ this.getLogPaths() == null)
return false;
if (other.getLogPaths() != null && other.getLogPaths().equals(this.getLogPaths()) == false)
return false;
if (other.getNewGameSessionProtectionPolicy() == null ^ this.getNewGameSessionProtectionPolicy() == null)
return false;
if (other.getNewGameSessionProtectionPolicy() != null
&& other.getNewGameSessionProtectionPolicy().equals(this.getNewGameSessionProtectionPolicy()) == false)
return false;
if (other.getOperatingSystem() == null ^ this.getOperatingSystem() == null)
return false;
if (other.getOperatingSystem() != null && other.getOperatingSystem().equals(this.getOperatingSystem()) == false)
return false;
if (other.getResourceCreationLimitPolicy() == null ^ this.getResourceCreationLimitPolicy() == null)
return false;
if (other.getResourceCreationLimitPolicy() != null && other.getResourceCreationLimitPolicy().equals(this.getResourceCreationLimitPolicy()) == false)
return false;
if (other.getMetricGroups() == null ^ this.getMetricGroups() == null)
return false;
if (other.getMetricGroups() != null && other.getMetricGroups().equals(this.getMetricGroups()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFleetId() == null) ? 0 : getFleetId().hashCode());
hashCode = prime * hashCode + ((getFleetArn() == null) ? 0 : getFleetArn().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getTerminationTime() == null) ? 0 : getTerminationTime().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getBuildId() == null) ? 0 : getBuildId().hashCode());
hashCode = prime * hashCode + ((getServerLaunchPath() == null) ? 0 : getServerLaunchPath().hashCode());
hashCode = prime * hashCode + ((getServerLaunchParameters() == null) ? 0 : getServerLaunchParameters().hashCode());
hashCode = prime * hashCode + ((getLogPaths() == null) ? 0 : getLogPaths().hashCode());
hashCode = prime * hashCode + ((getNewGameSessionProtectionPolicy() == null) ? 0 : getNewGameSessionProtectionPolicy().hashCode());
hashCode = prime * hashCode + ((getOperatingSystem() == null) ? 0 : getOperatingSystem().hashCode());
hashCode = prime * hashCode + ((getResourceCreationLimitPolicy() == null) ? 0 : getResourceCreationLimitPolicy().hashCode());
hashCode = prime * hashCode + ((getMetricGroups() == null) ? 0 : getMetricGroups().hashCode());
return hashCode;
}
@Override
public FleetAttributes clone() {
try {
return (FleetAttributes) 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.FleetAttributesMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}