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

class documentation

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

Constructor: ClusterServiceClient(channel)

View In Hierarchy

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 operation_service Return the client that manages long-running operations.
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 __operation_type__ Message type representing a long-running operation.
Class Variable __service_name__ Fully qualified protobuf service name for RPC routes.
Instance Variable __operation_service__ Undocumented

Inherited from ClientWithOperations:

Method __init__ Initialize the client-with-operations.
Class Variable __operation_service_class__ the client class used to manage operations.

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): (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.

The request object is returned without starting the RPC.

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

Deletes the specified PostgreSQL cluster.

The request object is returned without starting the RPC.

def get(self, request: GetClusterRequest, **kwargs: Unpack[RequestKwargs]) -> Request[GetClusterRequest, Cluster]: (source)

Returns the specified PostgreSQL Cluster resource. To get the list of available PostgreSQL Cluster resources, make a [List] request.

The request object is returned without starting the RPC.

def get_by_name(self, request: GetByNameRequest, **kwargs: Unpack[RequestKwargs]) -> Request[GetByNameRequest, Cluster]: (source)

Returns the specified PostgreSQL Cluster resource by name.

The request object is returned without starting the RPC.

def get_for_backup(self, request: GetClusterForBackupRequest, **kwargs: Unpack[RequestKwargs]) -> Request[GetClusterForBackupRequest, Cluster]: (source)

Returns the specified PostgreSQL Cluster resource for backup. It should be used as a hint of cluster configuration in case of backup restoration.

The request object is returned without starting the RPC.

def list(self, request: ListClustersRequest, **kwargs: Unpack[RequestKwargs]) -> Request[ListClustersRequest, ListClustersResponse]: (source)

Retrieves the list of PostgreSQL Cluster resources that belong to the specified folder.

The request object is returned without starting the RPC.

def operation_service(self): (source)
overrides nebius.aio.client.ClientWithOperations.operation_service

Return the client that manages long-running operations.

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

Creates a new PostgreSQL cluster from a previously created backup.

The request object is returned without starting the RPC.

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

Wakes up suspended PostgreSQL cluster.

The request object is returned without starting the RPC.

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

Suspends the PostgreSQL cluster to save resources.

The request object is returned without starting the RPC.

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

Updates the PostgreSQL cluster.

The request object is returned without starting the RPC.

__PB2_DESCRIPTOR__ = (source)

Alias for code that expects a protobuf service descriptor.

Value
_REGISTRY.service_descriptor('nebius.msp.postgresql.v1alpha1.ClusterService')
__api_service_name__: str = (source)
overrides nebius.aio.client.Client.__api_service_name__

API gateway name for service routes.

__operation_source_method__: str = (source)
overrides nebius.aio.client.ClientWithOperations.__operation_source_method__

RPC method that supplies the operation route.

__operation_type__ = (source)
overrides nebius.aio.client.ClientWithOperations.__operation_type__

Message type representing a long-running operation.

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

Fully qualified protobuf service name for RPC routes.

__operation_service__ = (source)
overrides nebius.aio.client.ClientWithOperations.__operation_service__

Undocumented