Interface TableConnection

  • All Superinterfaces:
    ApplyPolicyGroup, org.opendaylight.yangtools.yang.binding.Augmentable<TableConnection>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<TableConnections>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<TableConnectionKey>

    @Generated("mdsal-binding-generator")
    public interface TableConnection
    extends org.opendaylight.yangtools.yang.binding.ChildOf<TableConnections>, org.opendaylight.yangtools.yang.binding.Augmentable<TableConnection>, ApplyPolicyGroup, org.opendaylight.yangtools.yang.binding.Identifiable<TableConnectionKey>
    A list of connections between pairs of routing or forwarding tables, the of entries between which is specified by the import and export policy

    This class represents the following YANG schema fragment defined in module openconfig-network-instance

     list table-connection {
       key "src-table dst-table";
       leaf src-table {
         type leafref {
           path ../config/src-table;
         }
       }
       leaf dst-table {
         type leafref {
           path ../config/dst-table;
         }
       }
       container config {
         uses inter-table-policies-config;
       }
       container state {
         config false;
         uses inter-table-policies-config;
       }
       uses rpol:apply-policy-group;
     }
     

    To create instances of this class use TableConnectionBuilder.

    See Also:
    TableConnectionBuilder, TableConnectionKey
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.
    • Method Detail

      • implementedInterface

        default Class<TableConnection> implementedInterface()
        Specified by:
        implementedInterface in interface ApplyPolicyGroup
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • bindingHashCode

        static int bindingHashCode​(@NonNull TableConnection obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull TableConnection thisObj,
                                     Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        NullPointerException - if thisObj is null
      • bindingToString

        static String bindingToString​(@NonNull TableConnection obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null
      • getSrcTable

        String getSrcTable()
        Return srcTable, or null if it is not present.
             
                 The name of the table which should be utilised as the source of forwarding or
                 routing information
             
         
        Returns:
        String srcTable, or null if it is not present.
      • requireSrcTable

        default @NonNull String requireSrcTable()
        Return srcTable, guaranteed to be non-null.
             
                 The name of the table which should be utilised as the source of forwarding or
                 routing information
             
         
        Returns:
        String srcTable, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if srcTable is not present
      • getDstTable

        String getDstTable()
        Return dstTable, or null if it is not present.
             
                 The table to which routing entries should be exported
             
         
        Returns:
        String dstTable, or null if it is not present.
      • requireDstTable

        default @NonNull String requireDstTable()
        Return dstTable, guaranteed to be non-null.
             
                 The table to which routing entries should be exported
             
         
        Returns:
        String dstTable, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if dstTable is not present
      • getConfig

        Config getConfig()
        Return config, or null if it is not present.
             
                 Configuration parameters relating to the connection between tables
             
         
        Returns:
        Config config, or null if it is not present.
      • getState

        State getState()
        Return state, or null if it is not present.
             
                 State parameters relating to the connection between tables
             
         
        Returns:
        State state, or null if it is not present.