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.

See Also:

  • Method Details

    • 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 Servers 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 Servers 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 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FleetUtilization.Builder,FleetUtilization>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.