Class default

Hierarchy

default
- default

Index

Constructors

Properties

Methods

createAndSendRequest deleteWorkloadScheme get getForUser getWorkloadScheme getWorkloadSchemeMembers post postWorkloadSchemeMembers putWorkloadScheme putWorkloadSchemeDefault

Constructors

constructor

new default(__namedParameters: {
requestBuilder: default;
requestHandler: default;
}): default
Parameters
- __namedParameters: {
  requestBuilder: default;
  requestHandler: default;
  }
  - requestBuilder: default
  - requestHandler: default
Returns default
Inherited from default.constructor
- Defined in collections/abstractCollection.ts:13

Properties

`Protected` requestBuilder

requestBuilder: default

`Protected` requestHandler

requestHandler: default

Methods

`Protected` createAndSendRequest

createAndSendRequest(pathname: string, __namedParameters?: {
    body?: unknown;
    method?: Method;
    query?: {
        [key: string]: number | string | string[];
    };
}): Promise<any>
Parameters
- pathname: string
- __namedParameters: {
      body?: unknown;
      method?: Method;
      query?: {
          [key: string]: number | string | string[];
      };
  } = {}
  - Optional body?: unknown
  - Optional method?: Method
  - Optional query?: {
    [key: string]: number | string | string[];
    }
    - [key: string]: number | string | string[]
Returns Promise<any>
Inherited from default.createAndSendRequest
- Defined in collections/abstractCollection.ts:24

deleteWorkloadScheme

deleteWorkloadScheme(id: string): Promise<void>
Delete a workload scheme for the given id
Parameters
- id: string
Returns Promise<void>
- Defined in collections/workloadSchemes.ts:50

get

get(): Promise<ResultSetResponse<WorkloadSchemeResponse>>
Retrieve all workload schemes

Returns Promise<ResultSetResponse<WorkloadSchemeResponse>>
- Defined in collections/workloadSchemes.ts:13

getForUser

getForUser(accountId: string): Promise<WorkloadSchemeResponse>
Get user scheme
Parameters
- accountId: string
Returns Promise<WorkloadSchemeResponse>
- Defined in collections/workloadSchemes.ts:85

getWorkloadScheme

getWorkloadScheme(id: string): Promise<WorkloadSchemeResponse>
Retrieve an existing workload scheme for the given id
Parameters
- id: string
Returns Promise<WorkloadSchemeResponse>
- Defined in collections/workloadSchemes.ts:30

getWorkloadSchemeMembers

getWorkloadSchemeMembers(id: string): Promise<ResultSetResponse<UserResponse>>
Get members in a workload scheme
Parameters
- id: string
Returns Promise<ResultSetResponse<UserResponse>>
- Defined in collections/workloadSchemes.ts:68

post

post(workloadScheme: WorkloadScheme): Promise<WorkloadSchemeResponse>
Create a workload scheme
Parameters
- workloadScheme: WorkloadScheme
Returns Promise<WorkloadSchemeResponse>
- Defined in collections/workloadSchemes.ts:20

postWorkloadSchemeMembers

postWorkloadSchemeMembers(id: string, accountIds: string[]): Promise<void>
Set user workload scheme membership
Parameters
- id: string
- accountIds: string[]
Returns Promise<void>
- Defined in collections/workloadSchemes.ts:75

putWorkloadScheme

putWorkloadScheme(id: string, workloadScheme: WorkloadScheme): Promise<WorkloadSchemeResponse>
Update a workload scheme for the given id
Parameters
- id: string
- workloadScheme: WorkloadScheme
Returns Promise<WorkloadSchemeResponse>
- Defined in collections/workloadSchemes.ts:37

putWorkloadSchemeDefault

putWorkloadSchemeDefault(id: string): Promise<WorkloadSchemeResponse>
Set the default workload scheme
Parameters
- id: string
Returns Promise<WorkloadSchemeResponse>
- Defined in collections/workloadSchemes.ts:59

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { requestBuilder: default; requestHandler: default; }

requestBuilder: default

requestHandler: default

Returns default

Properties

Protected requestBuilder

Protected requestHandler

Methods

Protected createAndSendRequest

Parameters

pathname: string

__namedParameters: { body?: unknown; method?: Method; query?: { [key: string]: number | string | string[]; }; } = {}

Optional body?: unknown

Optional method?: Method

Optional query?: { [key: string]: number | string | string[]; }

[key: string]: number | string | string[]

Returns Promise<any>

deleteWorkloadScheme

Parameters

id: string

Returns Promise<void>

get

Returns Promise<ResultSetResponse<WorkloadSchemeResponse>>

getForUser

Parameters

accountId: string

Returns Promise<WorkloadSchemeResponse>

getWorkloadScheme

Parameters

id: string

Returns Promise<WorkloadSchemeResponse>

getWorkloadSchemeMembers

Parameters

id: string

Returns Promise<ResultSetResponse<UserResponse>>

post

Parameters

workloadScheme: WorkloadScheme

Returns Promise<WorkloadSchemeResponse>

postWorkloadSchemeMembers

Parameters

id: string

accountIds: string[]

Returns Promise<void>

putWorkloadScheme

Parameters

id: string

workloadScheme: WorkloadScheme

Returns Promise<WorkloadSchemeResponse>

putWorkloadSchemeDefault

Parameters

id: string

Returns Promise<WorkloadSchemeResponse>

Settings

Member Visibility

Theme

__namedParameters: {
requestBuilder: default;
requestHandler: default;
}

`Protected` requestBuilder

`Protected` requestHandler

`Protected` createAndSendRequest

__namedParameters: {
body?: unknown;
method?: Method;
query?: {
[key: string]: number | string | string[];
};
} = {}

`Optional` body?: unknown

`Optional` method?: Method

`Optional` query?: {
[key: string]: number | string | string[];
}