Class Route

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

Information about a route for a virtual interface.

See Also:

  • Method Details

    • cidr

      public final String cidr()

      The CIDR (prefix) of the route.

      Returns:
      The CIDR (prefix) of the route.

    • routeDirection

      public final RouteDirection routeDirection()

      The direction of the route.

      The valid values are accepted (received from the customer network) and advertised (advertised to the customer network).

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

      Returns:
      The direction of the route.

      The valid values are accepted (received from the customer network) and advertised (advertised to the customer network).

      See Also:

    • routeDirectionAsString

      public final String routeDirectionAsString()

      The direction of the route.

      The valid values are accepted (received from the customer network) and advertised (advertised to the customer network).

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

      Returns:
      The direction of the route.

      The valid values are accepted (received from the customer network) and advertised (advertised to the customer network).

      See Also:

    • addressFamily

      public final AddressFamily addressFamily()

      The address family of the route.

      The valid values are ipv4 and ipv6.

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

      Returns:
      The address family of the route.

      The valid values are ipv4 and ipv6.

      See Also:

    • addressFamilyAsString

      public final String addressFamilyAsString()

      The address family of the route.

      The valid values are ipv4 and ipv6.

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

      Returns:
      The address family of the route.

      The valid values are ipv4 and ipv6.

      See Also:

    • hasAsPath

      public final boolean hasAsPath()
      For responses, this returns true if the service returned a value for the AsPath 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.

    • asPath

      public final List<AsPathSegment> asPath()

      The autonomous system (AS) path of the route.

      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 hasAsPath() method.

      Returns:
      The autonomous system (AS) path of the route.

    • hasCommunities

      public final boolean hasCommunities()
      For responses, this returns true if the service returned a value for the Communities 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.

    • communities

      public final List<String> communities()

      The BGP communities associated with the route.

      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 hasCommunities() method.

      Returns:
      The BGP communities associated with the route.

    • awsLogicalDeviceId

      public final String awsLogicalDeviceId()

      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

      Returns:
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

    • routeInstalledAt

      public final Instant routeInstalledAt()

      The time when the route was installed. The value is displayed in UTC format.

      Returns:
      The time when the route was installed. The value is displayed in UTC format.

    • toBuilder

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

    • builder

      public static Route.Builder builder()

    • serializableBuilderClass

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