Working with Cloud Spark clusters
These methods allow you to manage the Cloud Spark clusters available in the project.
Get a list of all available Cloud Spark clusters.
Required token role: Administrator or User. Learn more about token roles.
No arguments.
A list of K8sClusterInfo class objects with information about the available Cloud Spark clusters.
Get detailed information about a Cloud Spark cluster by its identifier.
Required token role: Administrator or User. Learn more about token roles.
Argument | Type | Description |
|---|---|---|
(required) |
| Cloud Spark cluster identifier The list of Cloud Spark clusters and their identifiers can be obtained using the get_clusters method |
A K8sClusterInfo class object with information about the cluster.
Set the cluster idle time after which the cluster will be automatically deleted.
Required token role: Administrator. Learn more about token roles.
Argument | Type | Description |
|---|---|---|
(required) |
| Cloud Spark cluster identifier. The list of Cloud Spark clusters and their identifiers can be obtained using the get_clusters method |
(required) |
| Maximum cluster idle time in minutes |
A K8sClusterInfo class object. If successful, the delete_after_inactive_min field of the object will contain the specified maximum cluster idle time.
Remove the maximum cluster idle time after which the cluster will be automatically deleted.
Required token role: Administrator. Learn more about token roles.
Argument | Type | Description |
|---|---|---|
(required) |
| Cloud Spark cluster identifier. The list of Cloud Spark clusters and their identifiers can be obtained using the get_clusters method |
A K8sClusterInfo class object. If successful, the delete_after_inactive_min field of the object will contain the value None.
Set the cluster idle time after which the cluster will be automatically stopped.
Required token role: Administrator. Learn more about token roles.
Argument | Type | Description |
|---|---|---|
(required) |
| Cloud Spark cluster identifier. The list of Cloud Spark clusters and their identifiers can be obtained using the get_clusters method |
(required) |
| Maximum cluster idle time in minutes |
A K8sClusterInfo class object. If successful, the suspend_after_inactive_min field of the object will contain the specified maximum cluster idle time.
Remove the maximum cluster idle time after which the cluster will be automatically stopped.
Required token role: Administrator. Learn more about token roles.
Argument | Type | Description |
|---|---|---|
(required) |
| Cloud Spark cluster identifier. The list of Cloud Spark clusters and their identifiers can be obtained using the get_clusters method |
A K8sClusterInfo class object. If successful, the suspend_after_inactive_min field of the object will contain the value None.
Terminate all current connections to the cluster.
Required token role: Administrator. Learn more about token roles.
No arguments.
No return value.
Activate the cluster.
Required token role: Administrator. Learn more about token roles.
Argument | Type | Description |
|---|---|---|
(required) |
| Cloud Spark cluster identifier. The list of Cloud Spark clusters and their identifiers can be obtained using the get_clusters method |
No return value.