File tree Expand file tree Collapse file tree 5 files changed +98
-0
lines changed
api-reference/python/tilebox.workflows Expand file tree Collapse file tree 5 files changed +98
-0
lines changed Original file line number Diff line number Diff line change
1
+ ---
2
+ title : ClustersClient.all
3
+ icon : circle-nodes
4
+ ---
5
+
6
+ ``` python
7
+ def ClustersClient.all(): list[Cluster]
8
+ ```
9
+
10
+ List all available clusters.
11
+
12
+ ## Returns
13
+
14
+ A list of all available clusters.
15
+
16
+ <RequestExample >
17
+ ``` python Python
18
+ clusters = cluster_client.all()
19
+ ```
20
+ </RequestExample >
Original file line number Diff line number Diff line change
1
+ ---
2
+ title : ClustersClient.create
3
+ icon : circle-nodes
4
+ ---
5
+
6
+ ``` python
7
+ def ClustersClient.create(name: str ): Cluster
8
+ ```
9
+
10
+ Create a cluster.
11
+
12
+ ## Parameters
13
+
14
+ <ParamField path = " name" type = " string" >
15
+ A display name for the cluster
16
+ </ParamField >
17
+
18
+ ## Returns
19
+
20
+ The created cluster object.
21
+
22
+ <RequestExample >
23
+ ``` python Python
24
+ cluster = cluster_client.create(" My cluster" )
25
+ ```
26
+ </RequestExample >
Original file line number Diff line number Diff line change
1
+ ---
2
+ title : ClustersClient.delete
3
+ icon : circle-nodes
4
+ ---
5
+
6
+ ``` python
7
+ def ClustersClient.delete(cluster_or_slug: Cluster | str )
8
+ ```
9
+
10
+ Delete a cluster.
11
+
12
+ ## Parameters
13
+
14
+ <ParamField path = " cluster_or_slug" type = " Cluster | str" >
15
+ The cluster or cluster slug to delete.
16
+ </ParamField >
17
+
18
+ <RequestExample >
19
+ ``` python Python
20
+ cluster_client.delete(cluster)
21
+ ```
22
+ </RequestExample >
Original file line number Diff line number Diff line change
1
+ ---
2
+ title : ClustersClient.find
3
+ icon : circle-nodes
4
+ ---
5
+
6
+ ``` python
7
+ def ClustersClient.find(cluster_or_slug: Cluster | str ): Cluster
8
+ ```
9
+
10
+ Get a cluster by its slug.
11
+
12
+ ## Parameters
13
+
14
+ <ParamField path = " cluster_or_slug" type = " Cluster | str" >
15
+ The cluster or cluster slug to get.
16
+ </ParamField >
17
+
18
+ ## Returns
19
+
20
+ A cluster object.
21
+
22
+ <RequestExample >
23
+ ``` python Python
24
+ cluster = cluster_client.find(" my-cluster-CvufcSxcC9SKfe" )
25
+ ```
26
+ </RequestExample >
Original file line number Diff line number Diff line change 210
210
" api-reference/python/tilebox.workflows/TaskRunner.run_forever" ,
211
211
" api-reference/python/tilebox.workflows/ExecutionContext.submit_subtask" ,
212
212
" api-reference/python/tilebox.workflows/ExecutionContext.job_cache" ,
213
+ " api-reference/python/tilebox.workflows/ClustersClient.create" ,
214
+ " api-reference/python/tilebox.workflows/ClustersClient.find" ,
215
+ " api-reference/python/tilebox.workflows/ClustersClient.delete" ,
216
+ " api-reference/python/tilebox.workflows/ClustersClient.all" ,
213
217
" api-reference/python/tilebox.workflows/JobCache.group" ,
214
218
" api-reference/python/tilebox.workflows/JobCache.__iter__" ,
215
219
" api-reference/python/tilebox.workflows/JobClient.submit" ,
You can’t perform that action at this time.
0 commit comments