GroupDescription (ONOS Java API (2.3.0))

All Known Subinterfaces:

Group, StoredGroupEntry

All Known Implementing Classes:

DefaultGroup, DefaultGroupDescription
```
public interface GroupDescription
```
ONOS representation of group description that is used to create a group. It contains immutable properties of a ONOS group construct such as "type", "DeviceId", "appCookie", "appId" and "buckets"

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class GroupDescription.Type
Types of the group supported by ONOS.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`GroupKey`	`appCookie()`	Returns application cookie associated with a group object.
`ApplicationId`	`appId()`	Returns application identifier that has created this group object.
`GroupBuckets`	`buckets()`	Returns group buckets of a group.
`DeviceId`	`deviceId()`	Returns device identifier on which this group object is created.
`java.lang.Integer`	`givenGroupId()`	Returns groupId passed in by caller.
`GroupDescription.Type`	`type()`	Returns type of a group object.

- Method Detail
  - type
```
GroupDescription.Type type()
```
    Returns type of a group object.
    
    Returns:
    
    GroupType group type
  - deviceId
```
DeviceId deviceId()
```
    Returns device identifier on which this group object is created.
    
    Returns:
    
    DeviceId device identifier
  - appId
```
ApplicationId appId()
```
    Returns application identifier that has created this group object.
    
    Returns:
    
    ApplicationId application identifier
  - appCookie
```
GroupKey appCookie()
```
    Returns application cookie associated with a group object.
    
    Returns:
    
    GroupKey application cookie
  - givenGroupId
```
java.lang.Integer givenGroupId()
```
    Returns groupId passed in by caller.
    
    Returns:
    
    Integer group id passed in by caller. May be null if caller passed in null to let groupService determine the group id.
  - buckets
```
GroupBuckets buckets()
```
    Returns group buckets of a group.
    
    Returns:
    
    GroupBuckets immutable list of group bucket