nebius.api.nebius.ai.v1.EndpointServiceClient

Readme Code reference API Modules Classes Names

class documentation

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

Constructor: EndpointServiceClient(channel)

View In Hierarchy

Service to create/manage endpoints.

This class provides the client methods for the .nebius.ai.v1.EndpointService 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 an endpoint.
Method	`delete`	Deletes an endpoint.
Method	`get`	Returns the specified endpoint.
Method	`get_by_name`	Returns the specified endpoint by name.
Method	`list`	Retrieves a list of endpoints.
Method	`start`	Starts an endpoint.
Method	`stop`	Stops an endpoint.
Method	`update`	Updates an endpoint.
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: CreateEndpointRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[CreateEndpointRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Creates an endpoint.

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.ai.v1.CreateEndpointRequest`	The 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: DeleteEndpointRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[DeleteEndpointRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Deletes an endpoint.

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.ai.v1.DeleteEndpointRequest`	The 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: GetEndpointRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[GetEndpointRequest, Endpoint]: (source) ¶

Returns the specified endpoint.

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.ai.v1.GetEndpointRequest`	The request object to send.
**kwargs:`typing_extensions.Unpack[request_kwargs.RequestKwargs]`	Undocumented
Returns
`nebius.aio.request.Request` of `nebius.api.nebius.ai.v1.Endpoint`.	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: GetEndpointByNameRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[GetEndpointByNameRequest, Endpoint]: (source) ¶

Returns the specified endpoint 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.ai.v1.GetEndpointByNameRequest`	The request object to send.
**kwargs:`typing_extensions.Unpack[request_kwargs.RequestKwargs]`	Undocumented
Returns
`nebius.aio.request.Request` of `nebius.api.nebius.ai.v1.Endpoint`.	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: ListEndpointsRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[ListEndpointsRequest, ListEndpointsResponse]: (source) ¶

Retrieves a list of endpoints.

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.ai.v1.ListEndpointsRequest`	The request object to send.
**kwargs:`typing_extensions.Unpack[request_kwargs.RequestKwargs]`	Undocumented
Returns
`nebius.aio.request.Request` of `nebius.api.nebius.ai.v1.ListEndpointsResponse`.	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: StartEndpointRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[StartEndpointRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Starts an endpoint.

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.ai.v1.StartEndpointRequest`	The 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 stop(self, request: StopEndpointRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[StopEndpointRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Stops an endpoint.

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.ai.v1.StopEndpointRequest`	The 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 update(self, request: UpdateEndpointRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[UpdateEndpointRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Updates an endpoint.

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.ai.v1.UpdateEndpointRequest`	The 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.ai.v1.Endpoin↵
tService',
                                                          endpoint_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.