VirtualGroup
getGlobalVirtualGroup Query
| params | description |
|---|---|
| globalVirtualGroupId | virtual group id |
example
await client.virtualGroup.getGlobalVirtualGroup({
globalVirtualGroupId: 11,
});
getGlobalVirtualGroupByFamilyID Query
Query the virtual group family by ID.
Virtual group family(VGF) serve as a means of grouping global virtual groups. Each bucket must be associated with a unique global virtual group family and cannot cross families.
| params | description |
|---|---|
| globalVirtualGroupFamilyId | VGF id |
example
await client.virtualGroup.getGlobalVirtualGroupByFamilyID({
globalVirtualGroupFamilyId: 11,
});
getGlobalVirtualGroupFamily Query
| params | description |
|---|---|
| familyId | family id |
example
await client.virtualGroup.getGlobalVirtualGroupFamily({
familyId: 11,
});
getGlobalVirtualGroupFamilies Query
Get All global virtual group families.
| params | description |
|---|---|
| pagination | Pagination |
example
await client.virtualGroup.getGlobalVirtualGroupFamilies({
pagination: {
countTotal: true,
key: Uint8Array.from([]),
limit: Long.fromInt(10),
offset: Long.fromInt(0),
reverse: false,
},
});