Skip to main content

VirtualGroup

getGlobalVirtualGroup Query

paramsdescription
globalVirtualGroupIdvirtual 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.

paramsdescription
globalVirtualGroupFamilyIdVGF id
example
await client.virtualGroup.getGlobalVirtualGroupByFamilyID({
globalVirtualGroupFamilyId: 11,
});

getGlobalVirtualGroupFamily Query

paramsdescription
familyIdfamily id
example
await client.virtualGroup.getGlobalVirtualGroupFamily({
familyId: 11,
});

getGlobalVirtualGroupFamilies Query

Get All global virtual group families.

paramsdescription
paginationPagination
example
await client.virtualGroup.getGlobalVirtualGroupFamilies({
pagination: {
countTotal: true,
key: Uint8Array.from([]),
limit: Long.fromInt(10),
offset: Long.fromInt(0),
reverse: false,
},
});