Class ContainerPortMapping

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

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Defines how an internal-facing container port is mapped to an external-facing connection port on a fleet instance of compute type CONTAINER. Incoming traffic, such as a game client, uses a connection port to connect to a process in the container fleet. Amazon GameLift directs the inbound traffic to the container port that is assigned to the process, such as a game session, running on a container.

Part of: ContainerAttributes

See Also:

  • Method Details

    • containerPort

      public final Integer containerPort()

      The port opened on the container.

      Returns:
      The port opened on the container.

    • connectionPort

      public final Integer connectionPort()

      The port opened on the fleet instance. This is also called the "host port".

      Returns:
      The port opened on the fleet instance. This is also called the "host port".

    • protocol

      public final IpProtocol protocol()

      The network protocol that this mapping supports.

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

      Returns:
      The network protocol that this mapping supports.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The network protocol that this mapping supports.

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

      Returns:
      The network protocol that this mapping supports.
      See Also:

    • toBuilder

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

    • builder

      public static ContainerPortMapping.Builder builder()

    • serializableBuilderClass

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