Skip to main content

Class: ClusterService

Defined in: service/ClusterService.ts:92

Backwards-compatible class form. New code should call clusterService(client).

Constructors​

Constructor​

new ClusterService(client): ClusterService

Defined in: service/ClusterService.ts:94

Parameters​

client​

GraphQLClient

Returns​

ClusterService

Methods​

createCluster()​

createCluster(variables): Promise<Cluster>

Defined in: service/ClusterService.ts:109

Creates a new cluster

Parameters​

variables​

ClusterCreateVariables

Cluster creation variables

Returns​

Promise<Cluster>

deleteCluster()​

deleteCluster(variables): Promise<boolean>

Defined in: service/ClusterService.ts:119

Deletes a cluster

Parameters​

variables​

ClusterDeleteVariables

Cluster delete variables

Returns​

Promise<boolean>

getCluster()​

getCluster(variables, fetchOptions?): Promise<Cluster>

Defined in: service/ClusterService.ts:104

Fetches a single cluster by ID or slug

Parameters​

variables​

ClusterVariables

Variables for cluster query

fetchOptions?​

GraphQLFetchOptions

Returns​

Promise<Cluster>

getClusterConfig()​

getClusterConfig(clusterId, fetchOptions?): Promise<Cluster>

Defined in: service/ClusterService.ts:99

Retrieves a specific cluster configuration

Parameters​

clusterId​

number

Cluster ID to fetch

fetchOptions?​

GraphQLFetchOptions

Returns​

Promise<Cluster>

updateCluster()​

updateCluster(variables): Promise<Cluster>

Defined in: service/ClusterService.ts:114

Updates an existing cluster

Parameters​

variables​

ClusterUpdateVariables

Cluster update variables

Returns​

Promise<Cluster>