Class FleetUtilization
- java.lang.Object
-
- software.amazon.awssdk.services.gamelift.model.FleetUtilization
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<FleetUtilization.Builder,FleetUtilization>
@Generated("software.amazon.awssdk:codegen") public final class FleetUtilization extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FleetUtilization.Builder,FleetUtilization>
Current resource utilization statistics in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.
Related actions
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFleetUtilization.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IntegeractiveGameSessionCount()The number of active game sessions that are currently being hosted across all instances in the fleet location.IntegeractiveServerProcessCount()The number of server processes inACTIVEstatus that are currently running across all instances in the fleet location.static FleetUtilization.Builderbuilder()IntegercurrentPlayerSessionCount()The number of active player sessions that are currently being hosted across all instances in the fleet location.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfleetArn()The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it.StringfleetId()A unique identifier for the fleet associated with the location.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringlocation()The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region code, such asus-west-2.IntegermaximumPlayerSessionCount()The maximum number of players allowed across all game sessions that are currently being hosted across all instances in the fleet location.List<SdkField<?>>sdkFields()static Class<? extends FleetUtilization.Builder>serializableBuilderClass()FleetUtilization.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
fleetId
public final String fleetId()
A unique identifier for the fleet associated with the location.
- Returns:
- A unique identifier for the fleet associated with the location.
-
fleetArn
public final String fleetArn()
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.- Returns:
- The Amazon Resource Name (ARN) that is assigned to a
Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
-
activeServerProcessCount
public final Integer activeServerProcessCount()
The number of server processes in
ACTIVEstatus that are currently running across all instances in the fleet location.- Returns:
- The number of server processes in
ACTIVEstatus that are currently running across all instances in the fleet location.
-
activeGameSessionCount
public final Integer activeGameSessionCount()
The number of active game sessions that are currently being hosted across all instances in the fleet location.
- Returns:
- The number of active game sessions that are currently being hosted across all instances in the fleet location.
-
currentPlayerSessionCount
public final Integer currentPlayerSessionCount()
The number of active player sessions that are currently being hosted across all instances in the fleet location.
- Returns:
- The number of active player sessions that are currently being hosted across all instances in the fleet location.
-
maximumPlayerSessionCount
public final Integer maximumPlayerSessionCount()
The maximum number of players allowed across all game sessions that are currently being hosted across all instances in the fleet location.
- Returns:
- The maximum number of players allowed across all game sessions that are currently being hosted across all instances in the fleet location.
-
location
public final String location()
The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region code, such as
us-west-2.- Returns:
- The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region
code, such as
us-west-2.
-
toBuilder
public FleetUtilization.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FleetUtilization.Builder,FleetUtilization>
-
builder
public static FleetUtilization.Builder builder()
-
serializableBuilderClass
public static Class<? extends FleetUtilization.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-