Package software.amazon.awssdk.services.gamelift.model

Class RegisterGameServerRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.gamelift.model.GameLiftRequest
software.amazon.awssdk.services.gamelift.model.RegisterGameServerRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RegisterGameServerRequest.Builder,RegisterGameServerRequest>
@Generated("software.amazon.awssdk:codegen") public final class RegisterGameServerRequest extends GameLiftRequest implements ToCopyableBuilder<RegisterGameServerRequest.Builder,RegisterGameServerRequest>

  • Method Details

    • gameServerGroupName

      public final String gameServerGroupName()

      A unique identifier for the game server group where the game server is running.

      Returns:
      A unique identifier for the game server group where the game server is running.

    • gameServerId

      public final String gameServerId()

      A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account.

      Returns:
      A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account.

    • 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.

    • connectionInfo

      public final String connectionInfo()

      Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.

      Returns:
      Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.

    • gameServerData

      public final String gameServerData()

      A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

      Returns:
      A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.

    • toBuilder

      public RegisterGameServerRequest.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<RegisterGameServerRequest.Builder,RegisterGameServerRequest>
      Specified by:
      toBuilder in class GameLiftRequest
      Returns:
      a builder for type T

    • builder

      public static RegisterGameServerRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.