Class GatewayConnection

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

A gateway-managed connection for a service revision. A connection represents the association between the service's gateway connector and a specific gateway, along with the infrastructure that the gateway created for it.

See Also:

  • Method Details

    • gatewayArn

      public final String gatewayArn()

      The Amazon Resource Name (ARN) of the gateway.

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

    • gatewayRouteArn

      public final String gatewayRouteArn()

      The Amazon Resource Name (ARN) of the gateway route for the connection.

      Returns:
      The Amazon Resource Name (ARN) of the gateway route for the connection.

    • portName

      public final String portName()

      The name of the service port that receives gateway-managed ingress traffic.

      Returns:
      The name of the service port that receives gateway-managed ingress traffic.

    • serviceUrl

      public final String serviceUrl()

      The URL that the gateway uses to route ingress traffic to the service.

      Returns:
      The URL that the gateway uses to route ingress traffic to the service.

    • accessType

      public final AccessType accessType()

      The access type of the gateway ingress path.

      Valid values:

      • PUBLIC - The ingress path is publicly accessible.

      • PRIVATE - The ingress path is only accessible privately.

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

      Returns:
      The access type of the gateway ingress path.

      Valid values:

      • PUBLIC - The ingress path is publicly accessible.

      • PRIVATE - The ingress path is only accessible privately.

      See Also:

    • accessTypeAsString

      public final String accessTypeAsString()

      The access type of the gateway ingress path.

      Valid values:

      • PUBLIC - The ingress path is publicly accessible.

      • PRIVATE - The ingress path is only accessible privately.

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

      Returns:
      The access type of the gateway ingress path.

      Valid values:

      • PUBLIC - The ingress path is publicly accessible.

      • PRIVATE - The ingress path is only accessible privately.

      See Also:

    • status

      public final GatewayRouteStatus status()

      The status of the gateway route for the connection.

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

      Returns:
      The status of the gateway route for the connection.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the gateway route for the connection.

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

      Returns:
      The status of the gateway route for the connection.
      See Also:

    • resources

      public final GatewayConnectionResources resources()

      The gateway-managed infrastructure resources for the connection.

      Returns:
      The gateway-managed infrastructure resources for the connection.

    • toBuilder

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

    • builder

      public static GatewayConnection.Builder builder()

    • serializableBuilderClass

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