Class PortMapping

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

Returns the ports and associated IP addresses and ports of Amazon EC2 instances in your virtual private cloud (VPC) subnets. Custom routing is a port mapping protocol in Global Accelerator that statically associates port ranges with VPC subnets, which allows Global Accelerator to route to specific instances and ports within one or more subnets.

See Also:

  • Method Details

    • acceleratorPort

      public final Integer acceleratorPort()

      The accelerator port.

      Returns:
      The accelerator port.

    • endpointGroupArn

      public final String endpointGroupArn()

      The Amazon Resource Name (ARN) of the endpoint group.

      Returns:
      The Amazon Resource Name (ARN) of the endpoint group.

    • endpointId

      public final String endpointId()

      The IP address of the VPC subnet (the subnet ID).

      Returns:
      The IP address of the VPC subnet (the subnet ID).

    • destinationSocketAddress

      public final SocketAddress destinationSocketAddress()

      The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.

      Returns:
      The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.

    • protocols

      public final List<CustomRoutingProtocol> protocols()

      The protocols supported by the endpoint group.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProtocols() method.

      Returns:
      The protocols supported by the endpoint group.

    • hasProtocols

      public final boolean hasProtocols()
      For responses, this returns true if the service returned a value for the Protocols property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • protocolsAsStrings

      public final List<String> protocolsAsStrings()

      The protocols supported by the endpoint group.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProtocols() method.

      Returns:
      The protocols supported by the endpoint group.

    • destinationTrafficState

      public final CustomRoutingDestinationTrafficState destinationTrafficState()

      Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.

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

      Returns:
      Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.
      See Also:

    • destinationTrafficStateAsString

      public final String destinationTrafficStateAsString()

      Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.

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

      Returns:
      Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.
      See Also:

    • toBuilder

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

    • builder

      public static PortMapping.Builder builder()

    • serializableBuilderClass

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