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

class documentation

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

Constructor: ClusterServiceClient(channel)

View In Hierarchy

A set of methods for managing PostgreSQL Cluster resources.

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 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__ Undocumented
Class Variable __operation_source_method__ Undocumented
Class Variable __service_name__ Undocumented

Inherited from ClientWithOperations:

Method __init__ Undocumented
Method operation_service Undocumented
Class Variable __operation_service_class__ Undocumented
Class Variable __operation_type__ Undocumented
Instance Variable __operation_service__ Undocumented

Inherited from Client (via ClientWithOperations):

Method request Undocumented
Instance Variable _channel Undocumented
def create(self, request: CreateClusterRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[CreateClusterRequest, operation.Operation[v1alpha1_2.Operation]]: (source)

Creates a PostgreSQL cluster in the specified folder.

def delete(self, request: DeleteClusterRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[DeleteClusterRequest, operation.Operation[v1alpha1_2.Operation]]: (source)

Deletes the specified PostgreSQL cluster.

def get(self, request: GetClusterRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> 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.

def get_by_name(self, request: v1_1.GetByNameRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[v1_1.GetByNameRequest, Cluster]: (source)

Returns the specified PostgreSQL Cluster resource by name.

def list(self, request: ListClustersRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[ListClustersRequest, ListClustersResponse]: (source)

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

def restore(self, request: RestoreClusterRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[RestoreClusterRequest, operation.Operation[v1alpha1_2.Operation]]: (source)

Creates a new PostgreSQL cluster from a previously created backup.

def start(self, request: StartClusterRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[StartClusterRequest, operation.Operation[v1alpha1_2.Operation]]: (source)

Wakes up suspended PostgreSQL cluster.

def stop(self, request: StopClusterRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[StopClusterRequest, operation.Operation[v1alpha1_2.Operation]]: (source)

Suspends the PostgreSQL cluster to save resources.

def update(self, request: UpdateClusterRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[UpdateClusterRequest, operation.Operation[v1alpha1_2.Operation]]: (source)

Updates the PostgreSQL cluster.

__PB2_DESCRIPTOR__ = (source)

Undocumented

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__

Undocumented

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

Undocumented