Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.cluster.id.set

Interface ClusterIdSet

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<ClusterIdSet>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<ClusterIdSet>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<ClusterIdSetKey>
    @Generated("mdsal-binding-generator")
public interface ClusterIdSet
extends org.opendaylight.yangtools.yang.binding.ChildOf<ClusterIdSet>, org.opendaylight.yangtools.yang.binding.Augmentable<ClusterIdSet>, org.opendaylight.yangtools.yang.binding.Identifiable<ClusterIdSetKey>
    List of the defined cluster Ids sets

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

     list cluster-id-set {
   key cluster-id-set-name;
   leaf cluster-id-set-name {
     type string;
   }
   leaf-list cluster-id {
     type bgp-t:cluster-identifier;
   }
   container local {
     presence "Local cluster Id";
   }
 }
    The schema path to identify an instance is odl-bgp-policycluster-id-setcluster-id-set

    To create instances of this class use ClusterIdSetBuilder.

    See Also:
    ClusterIdSetBuilder, ClusterIdSetKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<ClusterIdSet> 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 ClusterIdSet 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 ClusterIdSet 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 ClusterIdSet 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

      • getClusterIdSetName

        String getClusterIdSetName()
        Return clusterIdSetName, or null if it is not present. 
             
         name / label of the set -- this is used to reference the set in match conditions
        Returns:
        String clusterIdSetName, or null if it is not present.

      • requireClusterIdSetName

        default @NonNull String requireClusterIdSetName()
        Return clusterIdSetName, guaranteed to be non-null. 
             
         name / label of the set -- this is used to reference the set in match conditions
        Returns:
        String clusterIdSetName, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if clusterIdSetName is not present

      • getClusterId

        @Nullable List<ClusterIdentifier> getClusterId()
        Return clusterId, or null if it is not present. 
             
         List of role expressions that are part of the set
        Returns:
        List<ClusterIdentifier> clusterId, or null if it is not present.

      • requireClusterId

        default @NonNull List<ClusterIdentifier> requireClusterId()
        Return clusterId, guaranteed to be non-null. 
             
         List of role expressions that are part of the set
        Returns:
        List<ClusterIdentifier> clusterId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if clusterId is not present

      • getLocal

        Local getLocal()
        Return local, or null if it is not present. 
             
         Validates also cluster Originator Id
        Returns:
        Local local, or null if it is not present.