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

class documentation

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

Constructor: ClusterServiceClient(channel)

View In Hierarchy

A set of methods for managing PostgreSQL Cluster resources.

This class provides the client methods for the .nebius.msp.postgresql.v1alpha1.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 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__ 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[v1alpha1_1.Operation]]: (source)

Creates a PostgreSQL cluster in the specified folder.

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.msp.postgresql.v1alpha1.CreateClusterRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1alpha1.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[v1alpha1_1.Operation]]: (source)

Deletes the specified PostgreSQL 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.msp.postgresql.v1alpha1.DeleteClusterRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1alpha1.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 the specified PostgreSQL Cluster resource. To get the list of available PostgreSQL Cluster resources, make a [List] request.

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.msp.postgresql.v1alpha1.GetClusterRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.msp.postgresql.v1alpha1.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 the specified PostgreSQL Cluster resource by 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.msp.postgresql.v1alpha1.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_for_backup(self, request: GetClusterForBackupRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.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.

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.msp.postgresql.v1alpha1.GetClusterForBackupRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.msp.postgresql.v1alpha1.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)

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

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.msp.postgresql.v1alpha1.ListClustersRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.msp.postgresql.v1alpha1.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 restore(self, request: RestoreClusterRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[RestoreClusterRequest, operation.Operation[v1alpha1_1.Operation]]: (source)

Creates a new PostgreSQL cluster from a previously created backup.

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.msp.postgresql.v1alpha1.RestoreClusterRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1alpha1.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 start(self, request: StartClusterRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[StartClusterRequest, operation.Operation[v1alpha1_1.Operation]]: (source)

Wakes up suspended PostgreSQL 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.msp.postgresql.v1alpha1.StartClusterRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1alpha1.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 stop(self, request: StopClusterRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[StopClusterRequest, operation.Operation[v1alpha1_1.Operation]]: (source)

Suspends the PostgreSQL cluster to save resources.

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.msp.postgresql.v1alpha1.StopClusterRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1alpha1.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 update(self, request: UpdateClusterRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[UpdateClusterRequest, operation.Operation[v1alpha1_1.Operation]]: (source)

Updates the PostgreSQL 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.msp.postgresql.v1alpha1.UpdateClusterRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1alpha1.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.msp.postgresq↵
l.v1alpha1.ClusterService',
                                                          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.