nebius.api.nebius.vpc.v1.PoolServiceClient

class documentation

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

Constructor: PoolServiceClient(channel)

View In Hierarchy

PoolService provides operations for managing pools.

This class provides client methods for the nebius.vpc.v1.PoolService service.

Class Method get_descriptor Return the protobuf service descriptor from the registry.
Method create Creates a new pool with the specified configuration.
Method delete Deletes a pool by its ID.
Method get Retrieves a pool by its ID.
Method get_by_name Retrieves a pool by its name within a specified parent.
Method list Lists pools within a specified parent.
Method list_aggregated Lists pools across regions for the specified parent.
Method list_by_source_pool Lists pools that use a specified pool as their source.
Method operation_service Return the client that manages long-running operations.
Method update Updates an existing pool with new configuration parameters.
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: CreatePoolRequest, **kwargs: Unpack[RequestKwargs]) -> Request[CreatePoolRequest, nebius.aio.operation.Operation[Operation]]: (source)

Creates a new pool with the specified configuration.

The request object is returned without starting the RPC.

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

Deletes a pool by its ID.

The request object is returned without starting the RPC.

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

Retrieves a pool by its ID.

The request object is returned without starting the RPC.

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

Retrieves a pool by its name within a specified parent.

The request object is returned without starting the RPC.

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

Lists pools within a specified parent.

The request object is returned without starting the RPC.

def list_aggregated(self, request: ListAggregatedPoolsRequest, **kwargs: Unpack[RequestKwargs]) -> Request[ListAggregatedPoolsRequest, ListPoolsResponse]: (source)

Lists pools across regions for the specified parent.

The request object is returned without starting the RPC.

def list_by_source_pool(self, request: ListPoolsBySourcePoolRequest, **kwargs: Unpack[RequestKwargs]) -> Request[ListPoolsBySourcePoolRequest, ListPoolsResponse]: (source)

Lists pools that use a specified pool as their source.

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 update(self, request: UpdatePoolRequest, **kwargs: Unpack[RequestKwargs]) -> Request[UpdatePoolRequest, nebius.aio.operation.Operation[Operation]]: (source)

Updates an existing pool with new configuration parameters.

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.vpc.v1.PoolService')
__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