Class GameServerInstance

java.lang.Object
software.amazon.awssdk.services.gamelift.model.GameServerInstance
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<GameServerInstance.Builder,GameServerInstance>
@Generated("software.amazon.awssdk:codegen") public final class GameServerInstance extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GameServerInstance.Builder,GameServerInstance>

This data type is used with the Amazon GameLift Servers FleetIQ and game server groups.

Additional properties, including status, that describe an EC2 instance in a game server group. Instance configurations are set with game server group properties (see DescribeGameServerGroup and with the EC2 launch template that was used when creating the game server group.

Retrieve game server instances for a game server group by calling DescribeGameServerInstances.

See Also:

  • Method Details

    • gameServerGroupName

      public final String gameServerGroupName()

      A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each Amazon Web Services account.

      Returns:
      A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each Amazon Web Services account.

    • gameServerGroupArn

      public final String gameServerGroupArn()

      A generated unique identifier for the game server group that includes the game server instance.

      Returns:
      A generated unique identifier for the game server group that includes the game server instance.

    • instanceId

      public final String instanceId()

      The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

      Returns:
      The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

    • instanceStatus

      public final GameServerInstanceStatus instanceStatus()

      Current status of the game server instance

      If the service returns an enum value that is not available in the current SDK version, instanceStatus will return GameServerInstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceStatusAsString().

      Returns:
      Current status of the game server instance
      See Also:

    • instanceStatusAsString

      public final String instanceStatusAsString()

      Current status of the game server instance

      If the service returns an enum value that is not available in the current SDK version, instanceStatus will return GameServerInstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceStatusAsString().

      Returns:
      Current status of the game server instance
      See Also:

    • toBuilder

      public GameServerInstance.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<GameServerInstance.Builder,GameServerInstance>
      Returns:
      a builder for type T

    • builder

      public static GameServerInstance.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GameServerInstance.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.