DatastoreShardId (controller-docs 4.0.1 API)

All Superinterfaces:

BindingObject, DataContainer, DataObject

All Known Subinterfaces:

AddShardReplicaInput, ChangeMemberVotingStatesForShardInput, GetShardRoleInput, LocateShardInput, MakeLeaderLocalInput, RemoveShardReplicaInput, ShardOperationResult, ShardResult
```
@Generated("mdsal-binding-generator")
public interface DatastoreShardId
extends 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 Summary

Fields
Modifier and Type Field Description

static @NonNull QName QNAME

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`DataStoreType`	`getDataStoreType()`	Return dataStoreType, or `null` if it is not present.
`String`	`getShardName()`	Return shardName, or `null` if it is not present.
`Class<? extends DatastoreShardId>`	`implementedInterface()`
`default @NonNull DataStoreType`	`requireDataStoreType()`	Return dataStoreType, guaranteed to be non-null.
`default @NonNull String`	`requireShardName()`	Return shardName, guaranteed to be non-null.

- Field Detail
  - QNAME
```
static final @NonNull QName QNAME
```
- Method Detail
  - implementedInterface
```
Class<? extends DatastoreShardId> implementedInterface()
```
    Specified by:
    
    implementedInterface in interface DataContainer
    
    Specified by:
    
    implementedInterface in interface DataObject
  - getShardName
```
String getShardName()
```
    Return shardName, or null if it is not present.
    The name of the shard.
    Returns:
    
    String shardName, or null if it is not present.
  - requireShardName
```
default @NonNull String requireShardName()
```
    Return shardName, guaranteed to be non-null.
    The name of the shard.
    Returns:
    
    String shardName, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if shardName is not present
  - getDataStoreType
```
DataStoreType getDataStoreType()
```
    Return dataStoreType, or null if it is not present.
    The type of the data store to which the shard belongs
    Returns:
    
    DataStoreType dataStoreType, or null if it is not present.
  - requireDataStoreType
```
default @NonNull DataStoreType requireDataStoreType()
```
    Return dataStoreType, guaranteed to be non-null.
    The type of the data store to which the shard belongs
    Returns:
    
    DataStoreType dataStoreType, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if dataStoreType is not present