nebius.api.nebius.msp.postgresql.v1alpha1.ClusterServiceClient

class documentation

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

Constructor: ClusterServiceClient(channel)

A set of methods for managing PostgreSQL Cluster resources.

This class provides client methods for the nebius.msp.postgresql.v1alpha1.ClusterService service.

Class Method	`get_descriptor`	Return the protobuf service descriptor from the registry.
Method	`create`	Creates a PostgreSQL cluster in the specified folder.
Method	`delete`	Deletes the specified PostgreSQL cluster.
Method	`get`	Returns the specified PostgreSQL Cluster resource. To get the list of available PostgreSQL Cluster resources, make a [List] request.
Method	`get_by_name`	Returns the specified PostgreSQL Cluster resource by name.
Method	`get_for_backup`	Returns the specified PostgreSQL Cluster resource for backup. It should be used as a hint of cluster configuration in case of backup restoration.
Method	`list`	Retrieves the list of PostgreSQL Cluster resources that belong to the specified folder.
Method	`restore`	Creates a new PostgreSQL cluster from a previously created backup.
Method	`start`	Wakes up suspended PostgreSQL cluster.
Method	`stop`	Suspends the PostgreSQL cluster to save resources.
Method	`update`	Updates the PostgreSQL cluster.
Constant	`__PB2_DESCRIPTOR__`	Alias for code that expects a protobuf service descriptor.
Class Variable	`__api_service_name__`	API gateway name for service routes.
Class Variable	`__operation_source_method__`	RPC method that supplies the operation route.
Class Variable	`__service_name__`	Fully qualified protobuf service name for RPC routes.

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.
Method	`stream_request`	Construct a native async request for a streaming RPC shape.
Class Variable	`__registry__`	Descriptor registry for request metadata.
Class Variable	`__service_deprecation_details__`	Optional deprecation message. The client writes this message to the warning log when it starts.
Instance Variable	`_channel`	Undocumented

@classmethod
def get_descriptor(cls) -> object: (source) ¶

Return the protobuf service descriptor from the registry.

def create(self, request: CreateClusterRequest, **kwargs: Unpack[RequestKwargs]) -> Request[CreateClusterRequest, nebius.aio.operation.Operation[Operation]]: (source) ¶

Creates a PostgreSQL cluster in the specified folder.