Class ServerConnectionsResource

Server Connections resource

Hierarchy

BaseResource
- ServerConnectionsResource

Index

Constructors

Properties

Methods

create delete executeAction get list request test update validateId validateRequiredString

Constructors

constructor

new ServerConnectionsResource(
client: any,
serverId: number,
): ServerConnectionsResource
Parameters
- client: any
- serverId: number
Returns ServerConnectionsResource
Overrides BaseResource.constructor
- Defined in server-extensions.ts:517

Properties

`Protected` `Readonly`client

client: TenantosClient

Methods

create

create(data: Partial<ServerConnection>): Promise<ServerConnection>
Parameters
- data: Partial<ServerConnection>
Returns Promise<ServerConnection>
- Defined in server-extensions.ts:530

delete

delete(id: number): Promise<void>
Parameters
- id: number
Returns Promise<void>
- Defined in server-extensions.ts:575

executeAction

executeAction(
    testConnectionId: number,
    serverConnectionAction: string,
    data?: any,
): Promise<void>
Parameters
- testConnectionId: number
- serverConnectionAction: string
- Optionaldata: any
Returns Promise<void>
- Defined in server-extensions.ts:602

get

get(id: number): Promise<ServerConnection>
Parameters
- id: number
Returns Promise<ServerConnection>
- Defined in server-extensions.ts:544

list

list(): Promise<ServerConnection[]>
Returns Promise<ServerConnection[]>
- Defined in server-extensions.ts:521

`Protected`request

request<T>(config: RequestConfig): Promise<ApiResponse<T>>
Make a request to the API with automatic error handling
Type Parameters
- T
Parameters
- config: RequestConfig
Returns Promise<ApiResponse<T>>
Inherited from BaseResource.request
- Defined in server-extensions.ts:82

test

test(testConnectionId: number): Promise<OperationResult<unknown>>
Parameters
- testConnectionId: number
Returns Promise<OperationResult<unknown>>
- Defined in server-extensions.ts:584

update

update(id: number, data: Partial<ServerConnection>): Promise<ServerConnection>
Parameters
- id: number
- data: Partial<ServerConnection>
Returns Promise<ServerConnection>
- Defined in server-extensions.ts:559

`Protected`validateId

validateId(id: number, resourceName?: string): void
Validate that an ID is a positive integer
Parameters
- id: number
- resourceName: string = 'Resource'
Returns void
Inherited from BaseResource.validateId
- Defined in server-extensions.ts:89

`Protected`validateRequiredString

validateRequiredString(value: string, fieldName: string): void
Validate required string field
Parameters
- value: string
- fieldName: string
Returns void
Inherited from BaseResource.validateRequiredString
- Defined in server-extensions.ts:98