Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.prefix.shard.configuration.rev170110.prefix.shards

Interface Shard

All Superinterfaces:

Augmentable<Shard>, BindingObject, ChildOf<PrefixShards>, DataContainer, DataObject, Identifiable<ShardKey>

public interface Shard
extends ChildOf<PrefixShards>, Augmentable<Shard>, Identifiable<ShardKey>

List of prefix-based shards configured.

This class represents the following YANG schema fragment defined in module UnqualifiedQName{localName=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 QName	QNAME

Method Summary

Modifier and Type	Method	Description
static boolean	bindingEquals(@NonNull Shard thisObj, Object obj)	Default implementation of Object.equals(Object) contract for this interface.
static int	bindingHashCode(@NonNull Shard obj)	Default implementation of Object.hashCode() contract for this interface.
static String	bindingToString(@NonNull Shard obj)	Default implementation of Object.toString() contract for this interface.
@Nullable InstanceIdentifier<?>	getPrefix()	Return prefix, or null if it is not present..
@Nullable Replicas	getReplicas()	Return replicas, or null if it is not present..
default Class<Shard>	implementedInterface()
ShardKey	key()

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation, augmentations

Field Detail

QNAME

static final @NonNull QName QNAME

Method Detail

implementedInterface

default Class<Shard> implementedInterface()

Specified by:

implementedInterface in interface DataContainer

Specified by:

implementedInterface in interface DataObject

bindingHashCode

static int bindingHashCode(@NonNull Shard 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 Shard 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 Shard 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

getPrefix

@Nullable InstanceIdentifier<?> getPrefix()

Return prefix, or null if it is not present..

     
         Prefix that this shard is rooted at.
     
 

Returns:

org.opendaylight.yangtools.yang.binding.InstanceIdentifier prefix, or null if it is not present.

getReplicas

@Nullable Replicas getReplicas()

Return replicas, or null if it is not present..

     
         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 it is not present.

key

ShardKey key()

Specified by:

key in interface Identifiable<ShardKey>