Class GatewayRoute

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

A gateway route, which represents the association between a service and a gateway and the service-specific infrastructure that the gateway manages for the service's revisions.

See Also:

  • Method Details

    • gatewayRouteArn

      public final String gatewayRouteArn()

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

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

    • serviceArn

      public final String serviceArn()

      The Amazon Resource Name (ARN) of the service associated with the route.

      Returns:
      The Amazon Resource Name (ARN) of the service associated with the route.

    • serviceContainerPortName

      public final String serviceContainerPortName()

      The task definition container port name that the route targets on the service.

      Returns:
      The task definition container port name that the route targets on the service.

    • status

      public final GatewayRouteStatus status()

      The status of the gateway route.

      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.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the gateway route.

      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.
      See Also:

    • serviceUrl

      public final String serviceUrl()

      The URL for accessing the service, including the https:// scheme.

      Returns:
      The URL for accessing the service, including the https:// scheme.

    • resources

      public final GatewayRouteResources resources()

      The service-specific infrastructure that the gateway manages for the route, keyed by gateway type.

      Returns:
      The service-specific infrastructure that the gateway manages for the route, keyed by gateway type.

    • toBuilder

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

    • builder

      public static GatewayRoute.Builder builder()

    • serializableBuilderClass

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