Interface AsPathSet

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<AsPathSet>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<AsPathSets>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<AsPathSetKey>

    @Generated("mdsal-binding-generator")
    public interface AsPathSet
    extends org.opendaylight.yangtools.yang.binding.ChildOf<AsPathSets>, org.opendaylight.yangtools.yang.binding.Augmentable<AsPathSet>, org.opendaylight.yangtools.yang.binding.Identifiable<AsPathSetKey>
    Definitions for AS path sets

    This class represents the following YANG schema fragment defined in module openconfig-bgp-policy

     list as-path-set {
       key as-path-set-name;
       leaf as-path-set-name {
         type string;
       }
       leaf-list as-path-set-member {
         type inet:as-number;
       }
     }
     

    To create instances of this class use AsPathSetBuilder.

    See Also:
    AsPathSetBuilder, AsPathSetKey
    • 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<AsPathSet> 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 AsPathSet 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 AsPathSet 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 AsPathSet 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
      • key

        AsPathSetKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<AsPathSetKey>
      • getAsPathSetName

        String getAsPathSetName()
        Return asPathSetName, or null if it is not present.
             
                 name of the AS path set -- this is used to reference the set in match conditions
             
         
        Returns:
        String asPathSetName, or null if it is not present.
      • requireAsPathSetName

        default @NonNull String requireAsPathSetName()
        Return asPathSetName, guaranteed to be non-null.
             
                 name of the AS path set -- this is used to reference the set in match conditions
             
         
        Returns:
        String asPathSetName, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if asPathSetName is not present
      • getAsPathSetMember

        @Nullable Set<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber> getAsPathSetMember()
        Return asPathSetMember, or null if it is not present.
             
                 AS path expression -- list of ASes in the set
             
         
        Returns:
        Set<AsNumber> asPathSetMember, or null if it is not present.
      • requireAsPathSetMember

        default @NonNull Set<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber> requireAsPathSetMember()
        Return asPathSetMember, guaranteed to be non-null.
             
                 AS path expression -- list of ASes in the set
             
         
        Returns:
        Set<AsNumber> asPathSetMember, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if asPathSetMember is not present