Class RouteServerRoute

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

Describes a route in the route server's routing database.

See Also:

  • Method Details

    • routeServerEndpointId

      public final String routeServerEndpointId()

      The ID of the route server endpoint that received this route.

      Returns:
      The ID of the route server endpoint that received this route.

    • routeServerPeerId

      public final String routeServerPeerId()

      The ID of the route server peer that advertised this route.

      Returns:
      The ID of the route server peer that advertised this route.

    • hasRouteInstallationDetails

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

    • routeInstallationDetails

      public final List<RouteServerRouteInstallationDetail> routeInstallationDetails()

      Details about the installation status of this route in route tables.

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

      Returns:
      Details about the installation status of this route in route tables.

    • routeStatus

      public final RouteServerRouteStatus routeStatus()

      The current status of the route in the routing database. Values are in-rib or in-fib depending on if the routes are in the RIB or the FIB database.

      The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.

      The Forwarding Information Base (FIB) serves as a forwarding table for what route server has determined are the best-path routes in the RIB after evaluating all available routing information and policies. The FIB routes are installed on the route tables. The FIB is recomputed whenever there are changes to the RIB.

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

      Returns:
      The current status of the route in the routing database. Values are in-rib or in-fib depending on if the routes are in the RIB or the FIB database.

      The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.

      The Forwarding Information Base (FIB) serves as a forwarding table for what route server has determined are the best-path routes in the RIB after evaluating all available routing information and policies. The FIB routes are installed on the route tables. The FIB is recomputed whenever there are changes to the RIB.

      See Also:

    • routeStatusAsString

      public final String routeStatusAsString()

      The current status of the route in the routing database. Values are in-rib or in-fib depending on if the routes are in the RIB or the FIB database.

      The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.

      The Forwarding Information Base (FIB) serves as a forwarding table for what route server has determined are the best-path routes in the RIB after evaluating all available routing information and policies. The FIB routes are installed on the route tables. The FIB is recomputed whenever there are changes to the RIB.

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

      Returns:
      The current status of the route in the routing database. Values are in-rib or in-fib depending on if the routes are in the RIB or the FIB database.

      The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.

      The Forwarding Information Base (FIB) serves as a forwarding table for what route server has determined are the best-path routes in the RIB after evaluating all available routing information and policies. The FIB routes are installed on the route tables. The FIB is recomputed whenever there are changes to the RIB.

      See Also:

    • prefix

      public final String prefix()

      The destination CIDR block of the route.

      Returns:
      The destination CIDR block of the route.

    • hasAsPaths

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

    • asPaths

      public final List<String> asPaths()

      The AS path attributes of the BGP 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 hasAsPaths() method.

      Returns:
      The AS path attributes of the BGP route.

    • med

      public final Integer med()

      The Multi-Exit Discriminator (MED) value of the BGP route.

      Returns:
      The Multi-Exit Discriminator (MED) value of the BGP route.

    • nextHopIp

      public final String nextHopIp()

      The IP address for the next hop.

      Returns:
      The IP address for the next hop.

    • toBuilder

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

    • builder

      public static RouteServerRoute.Builder builder()

    • serializableBuilderClass

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