Interface Shard

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Shard>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PrefixShards>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<ShardKey>

    public interface Shard
    extends org.opendaylight.yangtools.yang.binding.ChildOf<PrefixShards>, org.opendaylight.yangtools.yang.binding.Augmentable<Shard>, org.opendaylight.yangtools.yang.binding.Identifiable<ShardKey>
    List of prefix-based shards configured.

    This class represents the following YANG schema fragment defined in module prefix-shard-configuration

     list shard {
       key prefix;
       leaf prefix {
         type instance-identifier;
       }
       container replicas {
         leaf-list replica {
           type string;
         }
       }
     }
     
    The schema path to identify an instance is prefix-shard-configuration/prefix-shards/shard

    To create instances of this class use ShardBuilder.

    See Also:
    ShardBuilder, ShardKey
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        @Nullable org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> getPrefix()
        Prefix that this shard is rooted at.
        Returns:
        org.opendaylight.yangtools.yang.binding.InstanceIdentifier prefix, or null if not present
      • getReplicas

        @Nullable Replicas getReplicas()
        List of cluster member nodes that this shard is replicated on
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.prefix.shard.configuration.rev170110.prefix.shards.shard.Replicas replicas, or null if not present
      • key

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