Skip to main content

Function: clusterConfigService()

clusterConfigService(client): object

Defined in: service/ClusterConfigService.ts:25

Service for managing cluster configurations

Parameters​

client​

GraphQLClient

Returns​

clusterConfigSettingCreate()​

clusterConfigSettingCreate(variables): Promise<ClusterConfigSetting>

Create a new setting on the cluster configuration identified by the supplied global identifier.

Parameters​

variables​

ClusterConfigSettingCreateVariables

Returns​

Promise<ClusterConfigSetting>

clusterConfigSettingDelete()​

clusterConfigSettingDelete(variables): Promise<boolean>

Remove a cluster configuration setting identified by global identifier.

Parameters​

variables​

ClusterConfigSettingDeleteVariables

Returns​

Promise<boolean>

clusterConfigSettingUpdate()​

clusterConfigSettingUpdate(variables): Promise<ClusterConfigSetting>

Apply a partial update to a cluster configuration setting identified by global identifier.

Parameters​

variables​

ClusterConfigSettingUpdateVariables

Returns​

Promise<ClusterConfigSetting>

clusterConfigUpdate()​

clusterConfigUpdate(variables): Promise<ClusterConfig>

Apply a partial update to an existing cluster configuration.

Parameters​

variables​

ClusterConfigUpdateVariables

Returns​

Promise<ClusterConfig>

createClusterConfig()​

createClusterConfig(input): Promise<ClusterConfigResponse>

Creates a new cluster configuration *

Parameters​

input​

ClusterConfigCreateInput

Cluster config creation input *

Returns​

Promise<ClusterConfigResponse>

Promise<ClusterConfig> The created cluster configuration

getClusterConfig()​

getClusterConfig(clusterConfigId): Promise&lt;ClusterConfigResponse>

Retrieves a specific cluster configuration *

Parameters​

clusterConfigId​

number

Cluster config ID *

Returns​

Promise&lt;ClusterConfigResponse>

Promise<ClusterConfigResponse> Cluster configuration data

getClusterConfigs()​

getClusterConfigs(): Promise&lt;ClusterConfigResponse[]>

Retrieves cluster configurations *

Returns​

Promise&lt;ClusterConfigResponse[]>

Promise<ClusterConfigResponse[]> List of cluster configurations

getClusterConfigSetting()​

getClusterConfigSetting(variables): Promise&lt;ClusterConfigSetting>

Retrieve a single cluster configuration setting by global identifier.

Parameters​

variables​

ClusterConfigSettingVariables

Returns​

Promise&lt;ClusterConfigSetting>

getClusterConfigsPaginated()​

getClusterConfigsPaginated(variables): Promise&lt;ClusterConfigsResponse>

Search cluster configurations with filtering and pagination.

Parameters​

variables​

ClusterConfigsPaginatedVariables

Returns​

Promise&lt;ClusterConfigsResponse>

updateClusterConfigSetting()​

updateClusterConfigSetting(clusterConfigId, settingId, input): Promise&lt;UpdateClusterConfigSettingResponse>

Updates cluster configuration settings *

Parameters​

clusterConfigId​

number

Cluster config ID *

settingId​

number

Setting ID *

input​

ClusterConfigSettingUpdateInput

Cluster config setting update input *

Returns​

Promise&lt;UpdateClusterConfigSettingResponse>

Promise<UpdateClusterConfigSettingResponse> The update response