## Uses of Class
com.h3c.of.lib.dt.GroupId

- Packages that use GroupId
  Package | Description
  --- | ---
  com.h3c.of.ctl | Public API for the OpenFlow Controller.
  com.h3c.of.ctl.flow | Public API for the OpenFlow Flow Manager.
  com.h3c.of.json | JSON factory and codecs for Openflow structures.
  com.h3c.of.lib | OpenFlow Protocol Library.
  com.h3c.of.lib.dt | A set of classes representing data values used in the OpenFlow protocol.
  com.h3c.of.lib.instr | Representations of OpenFlow Protocol Instructions and Actions.
  com.h3c.of.lib.mp | Representations of OpenFlow Protocol Multipart Message bodies.
  com.h3c.of.lib.msg | Representations of OpenFlow Protocol Messages.
  com.h3c.sdn.api | Definitions of services for driving outbound external communications for interacting with peers and integrating with other external applications, e.g.
  com.h3c.sdn.flowmgr | Definitions of the services provided by the Flow Manager Application.
  com.h3c.sdn.teamcs | ...

- - ### Uses of GroupId in com.h3c.of.ctl

    Methods in com.h3c.of.ctl with parameters of type GroupId
    Modifier and Type | Method and Description
    --- | ---
    `MBodyGroupDescStats` | ControllerService.`getGroupDescription(DataPathId dpid, GroupId groupId)` Returns the group description for the given group ID, from the specified datapath.
    `MBodyGroupDescStats` | ControllerServiceAdapter.`getGroupDescription(DataPathId dpid, GroupId groupId)`
    `MBodyGroupStats` | ControllerService.`getGroupStats(DataPathId dpid, GroupId groupId)` Returns the group statistics for the given group ID, from the specified datapath.
    `MBodyGroupStats` | ControllerServiceAdapter.`getGroupStats(DataPathId dpid, GroupId groupId)`

  - ### Uses of GroupId in com.h3c.of.ctl.flow

    Methods in com.h3c.of.ctl.flow with parameters of type GroupId
    Modifier and Type | Method and Description
    --- | ---
    `MBodyGroupDescStats` | GroupTracker.`getGroupDescription(DataPathId dpid, GroupId groupId)` Returns the group description for the given group ID, from the specified datapath.
    `MBodyGroupStats` | GroupTracker.`getGroupStats(DataPathId dpid, GroupId groupId)` Returns the group statistics for the given group ID, from the specified datapath.

  - ### Uses of GroupId in com.h3c.of.json

    Methods in com.h3c.of.json that return GroupId
    Modifier and Type | Method and Description
    --- | ---
    `static GroupId` | CodecUtils.`decodeGroupId(com.fasterxml.jackson.databind.JsonNode value)` Converts JsonNode into GroupId object.

    Methods in com.h3c.of.json with parameters of type GroupId
    Modifier and Type | Method and Description
    --- | ---
    `static long` | CodecUtils.`encodeGroupId(GroupId groupId)` Converts GroupId into String that can be used as a JSON value.

  - ### Uses of GroupId in com.h3c.of.lib

    Methods in com.h3c.of.lib that return GroupId
    Modifier and Type | Method and Description
    --- | ---
    `GroupId` | OfPacketReader.`readGroupId()` Reads a (u32) group id from the buffer.

    Methods in com.h3c.of.lib with parameters of type GroupId
    Modifier and Type | Method and Description
    --- | ---
    `void` | OfPacketWriter.`write(GroupId id)` Writes a group id (u32) to the buffer.

  - ### Uses of GroupId in com.h3c.of.lib.dt

    Fields in com.h3c.of.lib.dt declared as GroupId
    Modifier and Type | Field and Description
    --- | ---
    `static GroupId` | GroupId.`ALL` All groups, for group delete commands or group stats requests; Since 1.1.
    `static GroupId` | GroupId.`ANY` Wildcard group used for flow stats requests; Since 1.1.
    `static GroupId` | GroupId.`MAX` Last usable group number; Since 1.1.

    Methods in com.h3c.of.lib.dt that return GroupId
    Modifier and Type | Method and Description
    --- | ---
    `static GroupId` | GroupId.`valueOf(byte[] bytes)` Returns an object that represents the group identifier defined by the specified byte array.
    `static GroupId` | GroupId.`valueOf(long gid)` Returns an object that represents the group id defined by the specified long.
    `static GroupId` | GroupId.`valueOf(String gidStr)` Returns an object that represents the group id defined by the specified string.

    Methods in com.h3c.of.lib.dt with parameters of type GroupId
    Modifier and Type | Method and Description
    --- | ---
    `int` | GroupId.`compareTo(GroupId o)` Implements the Comparable interface, to return group ids in natural order.

  - ### Uses of GroupId in com.h3c.of.lib.instr

    Methods in com.h3c.of.lib.instr that return GroupId
    Modifier and Type | Method and Description
    --- | ---
    `GroupId` | ActGroup.`getGroupId()` Returns the group id.

    Methods in com.h3c.of.lib.instr with parameters of type GroupId
    Modifier and Type | Method and Description
    --- | ---
    `static Action` | ActionFactory.`createAction(ProtocolVersion pv, ActionType type, GroupId id)` Creates a GROUP action.

  - ### Uses of GroupId in com.h3c.of.lib.mp

    Methods in com.h3c.of.lib.mp that return GroupId
    Modifier and Type | Method and Description
    --- | ---
    `GroupId` | MBodyGroupDescStats.`getGroupId()` Returns the group ID; Since 1.1.
    `GroupId` | MBodyGroupStats.`getGroupId()` Returns the group ID; Since 1.1.
    `GroupId` | MBodyGroupStatsRequest.`getGroupId()` Returns the group ID; Since 1.1.
    `GroupId` | MBodyFlowStatsRequest.`getOutGroup()` Returns the output group that flow entries are required to match; Since 1.1.

    Methods in com.h3c.of.lib.mp with parameters of type GroupId
    Modifier and Type | Method and Description
    --- | ---
    `MBodyMutableGroupDescStats` | MBodyMutableGroupDescStats.`groupId(GroupId groupId)` Sets the group ID; Since 1.1.
    `MBodyMutableGroupStats` | MBodyMutableGroupStats.`groupId(GroupId groupId)` Sets the group ID; Since 1.1.
    `MBodyMutableGroupStatsRequest` | MBodyMutableGroupStatsRequest.`groupId(GroupId groupId)` Sets the group ID; Since 1.1.
    `MBodyMutableFlowStatsRequest` | MBodyMutableFlowStatsRequest.`outGroup(GroupId outGroup)` Sets the requirement that matching flow entries include this as an output group; Since 1.1.

  - ### Uses of GroupId in com.h3c.of.lib.msg

    Methods in com.h3c.of.lib.msg that return GroupId
    Modifier and Type | Method and Description
    --- | ---
    `GroupId` | OfmGroupMod.`getGroupId()` Returns the group ID.
    `GroupId` | OfmFlowMod.`getOutGroup()` For `DELETE*` commands, requires matching entries to include this group as an output group; Since 1.1. A value of `Group#ANY` indicates no restriction.
    `GroupId` | Bucket.`getWatchGroup()` Returns the ID of the watch group.

    Methods in com.h3c.of.lib.msg with parameters of type GroupId
    Modifier and Type | Method and Description
    --- | ---
    `OfmMutableGroupMod` | OfmMutableGroupMod.`groupId(GroupId id)` Sets the group id; Since 1.1.
    `OfmMutableFlowMod` | OfmMutableFlowMod.`outGroup(GroupId outGroup)` Sets the out group; Since 1.1.
    `MutableBucket` | MutableBucket.`watchGroup(GroupId watchGroup)` Sets the watch group for this bucket; Since 1.1.

  - ### Uses of GroupId in com.h3c.sdn.api

    Methods in com.h3c.sdn.api with parameters of type GroupId
    Modifier and Type | Method and Description
    --- | ---
    `MBodyGroupDescStats` | RemoteControllerService.`getGroupDescription(SystemInformation system, DataPathId dpId, GroupId groupId)` Returns the group description from a particular member controller configured on the specified datapath and groupId.
    `MBodyGroupStats` | RemoteControllerService.`getGroupStats(SystemInformation system, DataPathId dpId, GroupId groupId)` Returns the group statistics from a particular member controller configured for the specified datapath and groupId.

  - ### Uses of GroupId in com.h3c.sdn.flowmgr

    Methods in com.h3c.sdn.flowmgr with parameters of type GroupId
    Modifier and Type | Method and Description
    --- | ---
    `MBodyGroupDescStats` | FlowRule.`group(GroupId groupId)` Returns the group description for the specified group ID.

  - ### Uses of GroupId in com.h3c.sdn.teamcs

    Methods in com.h3c.sdn.teamcs with parameters of type GroupId
    Modifier and Type | Method and Description
    --- | ---
    `MBodyGroupDescStats` | TeamControllerService.`getGroupDescription(DataPathId dpid, GroupId groupId)` Returns the group description on the specified datapath and groupId.
    `MBodyGroupStats` | TeamControllerService.`getGroupStats(DataPathId dpid, GroupId groupId)` Returns the group statistics on the specified datapath and groupId.

Copyright © 2014. All Rights Reserved.