Interface PathComputationClient

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<PathComputationClient>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PcepClientAttributes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

    @Generated("mdsal-binding-generator")
    public interface PathComputationClient
    extends org.opendaylight.yangtools.yang.binding.ChildOf<PcepClientAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<PathComputationClient>
    PCC-related run-time information. This container is only present when the node is connected through PCEP in a PCC role.

    This class represents the following YANG schema fragment defined in module network-topology-pcep

     container path-computation-client {
       config false;
       leaf ip-address {
         type inet:ip-address-no-zone;
       }
       container stateful-tlv;
       leaf state-sync {
         type pcc-sync-state;
         when ../stateful-tlv;
       }
       list reported-lsp {
         leaf name {
           type string;
         }
         key name;
         list path {
           leaf lsp-id {
             type rsvp:lsp-id;
           }
           key lsp-id;
           uses pcep:path-definition;
         }
         uses lsp-metadata;
       }
     }
     
    The schema path to identify an instance is network-topology-pceppcep-client-attributespath-computation-client

    To create instances of this class use PathComputationClientBuilder.

    See Also:
    PathComputationClientBuilder
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • Method Detail

      • implementedInterface

        default Class<PathComputationClient> implementedInterface()
        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 PathComputationClient 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 PathComputationClient 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 PathComputationClient 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
      • getIpAddress

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getIpAddress()
        Return ipAddress, or null if it is not present.
             
                 IP address which the node used to connected to the PCE. There are no guarantees
                 as to reachability of the address, nor its relationship to other control,
                 management, or data plane addresses.
             
         
        Returns:
        IpAddressNoZone ipAddress, or null if it is not present.
      • requireIpAddress

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone requireIpAddress()
        Return ipAddress, guaranteed to be non-null.
             
                 IP address which the node used to connected to the PCE. There are no guarantees
                 as to reachability of the address, nor its relationship to other control,
                 management, or data plane addresses.
             
         
        Returns:
        IpAddressNoZone ipAddress, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if ipAddress is not present
      • getStatefulTlv

        StatefulTlv getStatefulTlv()
        Return statefulTlv, or null if it is not present.
        Returns:
        StatefulTlv statefulTlv, or null if it is not present.
      • getStateSync

        PccSyncState getStateSync()
        Return stateSync, or null if it is not present.
        Returns:
        PccSyncState stateSync, or null if it is not present.
      • requireStateSync

        default @NonNull PccSyncState requireStateSync()
        Return stateSync, guaranteed to be non-null.
        Returns:
        PccSyncState stateSync, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if stateSync is not present
      • getReportedLsp

        @Nullable Map<ReportedLspKey,​ReportedLsp> getReportedLsp()
        Return reportedLsp, or null if it is not present.
        Returns:
        Map<ReportedLspKey, ReportedLsp> reportedLsp, or null if it is not present.
      • nonnullReportedLsp

        default @NonNull Map<ReportedLspKey,​ReportedLsp> nonnullReportedLsp()
        Return reportedLsp, or an empty list if it is not present.
        Returns:
        Map<ReportedLspKey, ReportedLsp> reportedLsp, or an empty list if it is not present.