nebius.api.nebius.tunnel.v1.TunnelServiceClient

class documentation

class TunnelServiceClient(client.ClientWithOperations[v1_1.Operation, v1_1.OperationServiceClient]): (source)

Constructor: TunnelServiceClient(channel)

View In Hierarchy

TunnelService provides methods for managing tunnels. It supports CRUD operations for creating secure tunnel connections for applications.

This class provides the client methods for the .nebius.tunnel.v1.TunnelService 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 new tunnel.
Method delete Deletes a tunnel by its identifier.
Method get Retrieves a tunnel by its identifier.
Method list Lists all tunnels within a parent.
Method update Updates an existing tunnel.
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: CreateTunnelRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[CreateTunnelRequest, operation.Operation[v1_1.Operation]]: (source)

Creates a new tunnel.

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.tunnel.v1.CreateTunnelRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1.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: DeleteTunnelRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[DeleteTunnelRequest, operation.Operation[v1_1.Operation]]: (source)

Deletes a tunnel by its identifier.

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.tunnel.v1.DeleteTunnelRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1.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: GetTunnelRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[GetTunnelRequest, Tunnel]: (source)

Retrieves a tunnel by its identifier.

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.tunnel.v1.GetTunnelRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.tunnel.v1.Tunnel.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: ListTunnelRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[ListTunnelRequest, ListTunnelsResponse]: (source)

Lists all tunnels within a parent.

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.tunnel.v1.ListTunnelRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.tunnel.v1.ListTunnelsResponse.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: UpdateTunnelRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[UpdateTunnelRequest, operation.Operation[v1_1.Operation]]: (source)

Updates an existing tunnel.

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.tunnel.v1.UpdateTunnelRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1.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.tunnel.v1.Tun↵
nelService',
                                                          tunnel_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.