nebius.api.nebius.mk8s.v1.ClusterServiceClient

class documentation

class ClusterServiceClient(client.ClientWithOperations[v1_1.Operation, v1_1.OperationServiceClient]): (source)

Constructor: ClusterServiceClient(channel)

View In Hierarchy

This class provides the client methods for the .nebius.mk8s.v1.ClusterService service.

Each method constructs a nebius.aio.request.Request object that represents the in-flight RPC. The request can be awaited (async) or waited synchronously using its .wait() helpers.

The request methods accept various parameters to configure metadata, timeouts, authorization, and retries. See individual method docstrings for details.

Method create Creates a new mk8s cluster.
Method delete Deletes an mk8s cluster.
Method get Returns a specific mk8s cluster by its unique identifier.
Method get_by_name Returns a specific mk8s cluster by its unique name.
Method list Returns a list of all mk8s clusters in the specified project.
Method list_control_plane_versions ListControlPlaneVersions returns all k8s release versions available in Nebius API.
Method update Modifies an existing mk8s cluster.
Constant __PB2_DESCRIPTOR__ The protobuf service descriptor extraction function.
Class Variable __operation_source_method__ The method name that can be used to fetch the address channel for the operation.
Class Variable __service_name__ The full protobuf service name.

Inherited from ClientWithOperations:

Method __init__ Initialize the client-with-operations.
Method operation_service Return a cached operation-service client instance.
Class Variable __operation_service_class__ the client class used to manage operations.
Class Variable __operation_type__ the protobuf message class used to represent long-running operations.
Instance Variable __operation_service__ cached instance of the operation-service client.

Inherited from Client (via ClientWithOperations):

Method request Construct a nebius.aio.request.Request for an RPC.
Class Variable __service_deprecation_details__ optional deprecation message emitted as a runtime warning when the client is constructed.
Instance Variable _channel Undocumented
def create(self, request: CreateClusterRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[CreateClusterRequest, operation.Operation[v1_1.Operation]]: (source)

Creates a new mk8s cluster.

Other parameters can be provided as keyword arguments in the **kwargs dictionary, including metadata, timeouts, and retries. See nebius.aio.request_kwargs.RequestKwargs for details.

Parameters
request:nebius.api.nebius.mk8s.v1.CreateClusterRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1.Operation.A nebius.aio.request.Request object representing the in-flight RPC. It can be awaited (async) or waited synchronously using its .wait() helpers.
def delete(self, request: DeleteClusterRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[DeleteClusterRequest, operation.Operation[v1_1.Operation]]: (source)

Deletes an mk8s cluster.

Other parameters can be provided as keyword arguments in the **kwargs dictionary, including metadata, timeouts, and retries. See nebius.aio.request_kwargs.RequestKwargs for details.

Parameters
request:nebius.api.nebius.mk8s.v1.DeleteClusterRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1.Operation.A nebius.aio.request.Request object representing the in-flight RPC. It can be awaited (async) or waited synchronously using its .wait() helpers.
def get(self, request: GetClusterRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[GetClusterRequest, Cluster]: (source)

Returns a specific mk8s cluster by its unique identifier.

Other parameters can be provided as keyword arguments in the **kwargs dictionary, including metadata, timeouts, and retries. See nebius.aio.request_kwargs.RequestKwargs for details.

Parameters
request:nebius.api.nebius.mk8s.v1.GetClusterRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.mk8s.v1.Cluster.A nebius.aio.request.Request object representing the in-flight RPC. It can be awaited (async) or waited synchronously using its .wait() helpers.
def get_by_name(self, request: v1_1.GetByNameRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[v1_1.GetByNameRequest, Cluster]: (source)

Returns a specific mk8s cluster by its unique name.

Other parameters can be provided as keyword arguments in the **kwargs dictionary, including metadata, timeouts, and retries. See nebius.aio.request_kwargs.RequestKwargs for details.

Parameters
request:nebius.api.nebius.common.v1.GetByNameRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.mk8s.v1.Cluster.A nebius.aio.request.Request object representing the in-flight RPC. It can be awaited (async) or waited synchronously using its .wait() helpers.
def list(self, request: ListClustersRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[ListClustersRequest, ListClustersResponse]: (source)

Returns a list of all mk8s clusters in the specified project.

Other parameters can be provided as keyword arguments in the **kwargs dictionary, including metadata, timeouts, and retries. See nebius.aio.request_kwargs.RequestKwargs for details.

Parameters
request:nebius.api.nebius.mk8s.v1.ListClustersRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.mk8s.v1.ListClustersResponse.A nebius.aio.request.Request object representing the in-flight RPC. It can be awaited (async) or waited synchronously using its .wait() helpers.
def list_control_plane_versions(self, request: ListClusterControlPlaneVersionsRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[ListClusterControlPlaneVersionsRequest, ListClusterControlPlaneVersionsResponse]: (source)

ListControlPlaneVersions returns all k8s release versions available in Nebius API.

Other parameters can be provided as keyword arguments in the **kwargs dictionary, including metadata, timeouts, and retries. See nebius.aio.request_kwargs.RequestKwargs for details.

Parameters
request:nebius.api.nebius.mk8s.v1.ListClusterControlPlaneVersionsRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.mk8s.v1.ListClusterControlPlaneVersionsResponse.A nebius.aio.request.Request object representing the in-flight RPC. It can be awaited (async) or waited synchronously using its .wait() helpers.
def update(self, request: UpdateClusterRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[UpdateClusterRequest, operation.Operation[v1_1.Operation]]: (source)

Modifies an existing mk8s cluster.

Other parameters can be provided as keyword arguments in the **kwargs dictionary, including metadata, timeouts, and retries. See nebius.aio.request_kwargs.RequestKwargs for details.

Parameters
request:nebius.api.nebius.mk8s.v1.UpdateClusterRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1.Operation.A nebius.aio.request.Request object representing the in-flight RPC. It can be awaited (async) or waited synchronously using its .wait() helpers.
__PB2_DESCRIPTOR__ = (source)

The protobuf service descriptor extraction function.

Value
descriptor.DescriptorWrap[descriptor_1.ServiceDescriptor]('.nebius.mk8s.v1.Clust↵
erService',
                                                          cluster_service_pb2.DESCRIPTOR↵
,
                                                          descriptor_1.ServiceDescriptor↵
)
__operation_source_method__: str = (source)
overrides nebius.aio.client.ClientWithOperations.__operation_source_method__

The method name that can be used to fetch the address channel for the operation.

__service_name__: str = (source)
overrides nebius.aio.client.Client.__service_name__

The full protobuf service name.