@acceleratxr/core_sdk / ShardService
Class: ShardService#
Hierarchy#
-
↳ ShardService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new ShardService(apiClient: ApiClient, config: Configuration): ShardService
Overrides ServiceBase.constructor
Defined in src/services/ShardService.ts:11
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: ShardService
Properties#
apiClient#
• Protected apiClient: ApiClient
Inherited from ServiceBase.apiClient
Defined in src/ServiceBase.ts:14
The API Client used when making requests to the API backend server.
config#
• Protected config: Configuration
Inherited from ServiceBase.config
Defined in src/ServiceBase.ts:19
The SDK configuration to use.
uuid#
▪ Static uuid: string = “b7e536d2-6353-4cce-8f90-8425dea125f7”
Defined in src/services/ShardService.ts:17
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/ShardService.ts:46
Returns the count of groups
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
countByZoneUid#
▸ countByZoneUid(zoneUid: string, query?: any): Promise<number>
Defined in src/services/ShardService.ts:156
Returns the count of all shards from the system within a given zone.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
any |
Returns: Promise<number>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/ShardService.ts:104
Deletes the group
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<Shard[] | undefined>
Defined in src/services/ShardService.ts:22
Returns all groups from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Shard[] | undefined>
findAllByZoneUid#
▸ findAllByZoneUid(zoneUid: string, query?: any): Promise<Shard[] | undefined>
Defined in src/services/ShardService.ts:143
Returns all shards from the system within a given zone.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
any |
Returns: Promise<Shard[] | undefined>
findById#
▸ findById(id: string): Promise<Shard | undefined>
Defined in src/services/ShardService.ts:65
Returns a single group from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Shard | undefined>
findPreferredByZoneUid#
▸ findPreferredByZoneUid(zoneUid: string, query?: any): Promise<Shard[] | undefined>
Defined in src/services/ShardService.ts:182
Returns a list of preferred shards from the system within a given zone for the authenticated user, sorted from most preferable to least.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
any |
Returns: Promise<Shard[] | undefined>
join#
▸ join(id: string): Promise<Shard | undefined>
Defined in src/services/ShardService.ts:117
Requests that the authenticated user wants to join the specified shard.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Shard | undefined>
leave#
▸ leave(id: string): Promise<void>
Defined in src/services/ShardService.ts:130
Requests that the authenticated user wants to leave the specified shard.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
truncate#
▸ truncate(query?: any): Promise<void>
Defined in src/services/ShardService.ts:34
Deletes all roles from the service.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<void>
update#
▸ update(id: string, obj: Shard): Promise<Shard | undefined>
Defined in src/services/ShardService.ts:78
Updates a single group
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<Shard | undefined>
updateHeartbeat#
▸ updateHeartbeat(id: string): Promise<Shard | undefined>
Defined in src/services/ShardService.ts:91
Updates a single group
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Shard | undefined>