Region (ONOS Java API (2.2.5))

All Superinterfaces:

Annotated

All Known Implementing Classes:

DefaultRegion
```
public interface Region
extends Annotated
```
Representation of a group of devices located in a common physical or logical region. Optionally, devices in the region can share the same cluster nodes mastership affinities.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class Region.Type
Coarse representation of the type of the region.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`RegionId`	`id()`	Returns the unique identifier of the region.
`java.util.List<java.util.Set<NodeId>>`	`masters()`	Returns the list of master node sets.
`java.lang.String`	`name()`	Returns the friendly region name that can be used for display purposes.
`Region.Type`	`type()`	Returns the region type.

Methods inherited from interface org.onosproject.net.Annotated
annotations

- Method Detail
  - id
```
RegionId id()
```
    Returns the unique identifier of the region.
    
    Returns:
    
    region identifier
  - name
```
java.lang.String name()
```
    Returns the friendly region name that can be used for display purposes.
    
    Returns:
    
    friendly name of the region
  - type
```
Region.Type type()
```
    Returns the region type.
    
    Returns:
    
    region type
  - masters
```
java.util.List<java.util.Set<NodeId>> masters()
```
    Returns the list of master node sets. The sets of cluster node identifiers should be listed in the order of preferred mastership. Nodes specified in each sets should be considered with equally priority and devices in the region can be balanced between them based on other criteria, e.g. load.
    
    Returns:
    
    list of preferred master node sets