Interface DatastoreShardId

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    AddShardReplicaInput, ChangeMemberVotingStatesForShardInput, GetShardRoleInput, LocateShardInput, MakeLeaderLocalInput, RemoveShardReplicaInput, ShardOperationResult, ShardResult

    public interface DatastoreShardId
    extends org.opendaylight.yangtools.yang.binding.DataObject
    Grouping holding combined identifiers of a shard -- its name and datastore type

    This class represents the following YANG schema fragment defined in module cluster-admin

     grouping datastore-shard-id {
       leaf shard-name {
         type string {
           length 1..max {
             error-app-tag odl-named-shards;
             error-message
               "Shard name must not be empty";
           }
         }
       }
       leaf data-store-type {
         type data-store-type;
       }
     }
     
    The schema path to identify an instance is cluster-admin/datastore-shard-id
    • Field Detail

      • QNAME

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

      • implementedInterface

        Class<? extends DatastoreShardId> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • getShardName

        @Nullable String getShardName()
        The name of the shard.
        Returns:
        java.lang.String shardName, or null if not present
      • getDataStoreType

        @Nullable DataStoreType getDataStoreType()
        The type of the data store to which the shard belongs
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.DataStoreType dataStoreType, or null if not present