Interface PcreqMessage

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

    @Generated("mdsal-binding-generator")
    public interface PcreqMessage
    extends org.opendaylight.yangtools.yang.binding.ChildOf<PcreqMessage>, org.opendaylight.yangtools.yang.binding.Augmentable<PcreqMessage>, MessageHeader
    Path Computation Request Message

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

     container pcreq-message {
       uses message-header;
       list requests {
         uses rp-object;
         container path-key-expansion {
           when "rp/path-key = true";
           uses path-key-object;
         }
         container segment-computation {
           when "rp/path-key = false";
           container p2p {
             when "../rp/p2mp = false";
             uses endpoints-object;
             container reported-route {
               uses reported-route-object;
               uses reoptimization-bandwidth-object;
             }
             uses vendor-information-objects;
             uses load-balancing-object;
             uses lsp-attributes;
           }
           container p2mp {
             when "../rp/p2mp = true";
             list endpoint-rro-pair {
               uses endpoints-object;
               list rros {
                 choice route-object {
                   case reported-route-object-case {
                     uses reported-route-object;
                   }
                   case secondary-reported-route-object-case {
                     uses secondary-reported-route-object;
                   }
                 }
               }
               uses reoptimization-bandwidth-object;
               min-elements 1;
             }
             uses of-object;
             uses lspa-object;
             uses bandwidth-object;
             list metric {
               uses metric-object;
             }
             choice iro-bnc-choice {
               case iro-case {
                 uses include-route-object;
               }
               case bnc-case {
                 uses bnc-object;
               }
             }
             uses load-balancing-object;
           }
         }
         uses vendor-information-objects;
       }
       list svec {
         uses svec-object;
         uses of-object;
         uses gc-object;
         uses exclude-route-object;
         list metric {
           uses metric-object;
         }
         uses vendor-information-objects;
       }
       container monitoring-request {
         uses monitoring;
         list pce-id-list {
           uses pce-id-object;
         }
       }
     }
     
    The schema path to identify an instance is pcep-typespcreq-messagepcreq-message

    To create instances of this class use PcreqMessageBuilder.

    See Also:
    PcreqMessageBuilder
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        static int bindingHashCode​(@NonNull PcreqMessage 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 PcreqMessage 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 PcreqMessage 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
      • getRequests

        @Nullable List<Requests> getRequests()
        Return requests, or null if it is not present.
        Returns:
        List<Requests> requests, or null if it is not present.
      • nonnullRequests

        default @NonNull List<Requests> nonnullRequests()
        Return requests, or an empty list if it is not present.
        Returns:
        List<Requests> requests, or an empty list if it is not present.
      • getSvec

        @Nullable List<Svec> getSvec()
        Return svec, or null if it is not present.
        Returns:
        List<Svec> svec, or null if it is not present.
      • nonnullSvec

        default @NonNull List<Svec> nonnullSvec()
        Return svec, or an empty list if it is not present.
        Returns:
        List<Svec> svec, or an empty list if it is not present.
      • getMonitoringRequest

        MonitoringRequest getMonitoringRequest()
        Return monitoringRequest, or null if it is not present.
        Returns:
        MonitoringRequest monitoringRequest, or null if it is not present.