@acceleratxr/core_sdk / ServerInstanceService
Class: ServerInstanceService#
Hierarchy#
-
↳ ServerInstanceService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new ServerInstanceService(apiClient: ApiClient, config: Configuration): ServerInstanceService
Overrides ServiceBase.constructor
Defined in src/services/ServerInstanceService.ts:10
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: ServerInstanceService
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 = “54e9eb64-1ecb-485a-9aff-8bba7cbbc3c6”
Defined in src/services/ServerInstanceService.ts:16
Methods#
assignServer#
▸ assignServer(request: AssignServerInstance): Promise<ServerInstance | undefined>
Defined in src/services/ServerInstanceService.ts:21
Request a server instance assignment.
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<ServerInstance | undefined>
count#
▸ count(query?: any): Promise<number>
Defined in src/services/ServerInstanceService.ts:93
Returns the count of groups
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: ServerInstance): Promise<ServerInstance | undefined>
Defined in src/services/ServerInstanceService.ts:69
Create a new group
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<ServerInstance | undefined>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/ServerInstanceService.ts:151
Deletes the group
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<ServerInstance[] | undefined>
Defined in src/services/ServerInstanceService.ts:57
Returns all groups from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<ServerInstance[] | undefined>
findById#
▸ findById(id: string): Promise<ServerInstance | undefined>
Defined in src/services/ServerInstanceService.ts:112
Returns a single group from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<ServerInstance | undefined>
getRegions#
▸ getRegions(query?: any): Promise<string[] | undefined>
Defined in src/services/ServerInstanceService.ts:33
Returns a array of available server regions.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<string[] | undefined>
getVersions#
▸ getVersions(query?: any): Promise<string[] | undefined>
Defined in src/services/ServerInstanceService.ts:45
Returns a array of available server build versions.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<string[] | undefined>
truncate#
▸ truncate(query?: any): Promise<void>
Defined in src/services/ServerInstanceService.ts:81
Deletes all roles from the service.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<void>
update#
▸ update(id: string, obj: ServerInstance): Promise<ServerInstance | undefined>
Defined in src/services/ServerInstanceService.ts:125
Updates a single group
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<ServerInstance | undefined>
updateHeartbeat#
▸ updateHeartbeat(id: string): Promise<ServerInstance | undefined>
Defined in src/services/ServerInstanceService.ts:138
Updates a single group
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<ServerInstance | undefined>