software.amazon.awssdk.services.gamelift.model

Class FleetUtilization

java.lang.Object

software.amazon.awssdk.services.gamelift.model.FleetUtilization

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FleetUtilization.Builder,FleetUtilization>

@Generated(value="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

DescribeFleetUtilization | DescribeFleetLocationUtilization

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FleetUtilization.Builder

Method Summary

Modifier and Type	Method and Description
Integer	activeGameSessionCount() The number of active game sessions that are currently being hosted across all instances in the fleet location.
Integer	activeServerProcessCount() The number of server processes in ACTIVE status that are currently running across all instances in the fleet location.
static FleetUtilization.Builder	builder()
Integer	currentPlayerSessionCount() The number of active player sessions that are currently being hosted across all instances in the fleet location.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetArn() The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it.
String	fleetId() A unique identifier for the fleet associated with the location.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	location() The fleet location for the fleet utilization information, expressed as an AWS Region code, such as us-west-2.
Integer	maximumPlayerSessionCount() 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.Builder	toBuilder()
String	toString() 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 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 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 ACTIVE status that are currently running across all instances in the fleet location.

Returns:

The number of server processes in ACTIVE status 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 AWS Region code, such as us-west-2.

Returns:

The fleet location for the fleet utilization information, expressed as an AWS Region code, such as us-west-2.

toBuilder

public FleetUtilization.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FleetUtilization.Builder,FleetUtilization>

builder

public static FleetUtilization.Builder builder()

serializableBuilderClass

public static Class<? extends FleetUtilization.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo