nebius.api.nebius.compute.v1.InstanceServiceClient

Readme Code reference API Modules Classes Names

class documentation

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

Constructor: InstanceServiceClient(channel)

View In Hierarchy

This class provides the client methods for the .nebius.compute.v1.InstanceService 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 VM instance based on the provided specification. For details, see https://docs.nebius.com/compute/virtual-machines/manage
Method	`delete`	Deletes a VM instance by its ID.
Method	`get`	Retrieves detailed information about a specific VM instance by its ID.
Method	`get_by_name`	Retrieves detailed information about a specific VM instance by its parent and name.
Method	`list`	Lists all VM instances within a specified parent.
Method	`list_operations_by_parent`	Lists all operations that were performed within a specific parent resource.
Method	`start`	Starts a stopped VM instance.
Method	`stop`	Stops a running VM instance.
Method	`update`	Updates an existing VM instance with new configuration parameters.
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: CreateInstanceRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[CreateInstanceRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Creates a new VM instance based on the provided specification. For details, see https://docs.nebius.com/compute/virtual-machines/manage

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

Deletes a VM instance by its ID.

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.compute.v1.DeleteInstanceRequest`	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: GetInstanceRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[GetInstanceRequest, Instance]: (source) ¶

Retrieves detailed information about a specific VM instance by its ID.

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

Retrieves detailed information about a specific VM instance by its parent and 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.GetByNameRequest`	The request object to send.
**kwargs:`typing_extensions.Unpack[request_kwargs.RequestKwargs]`	Undocumented
Returns
`nebius.aio.request.Request` of `nebius.api.nebius.compute.v1.Instance`.	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: ListInstancesRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[ListInstancesRequest, ListInstancesResponse]: (source) ¶

Lists all VM instances within a specified 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.compute.v1.ListInstancesRequest`	The request object to send.
**kwargs:`typing_extensions.Unpack[request_kwargs.RequestKwargs]`	Undocumented
Returns
`nebius.aio.request.Request` of `nebius.api.nebius.compute.v1.ListInstancesResponse`.	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_operations_by_parent(self, request: ListOperationsByParentRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[ListOperationsByParentRequest, v1_1.ListOperationsResponse]: (source) ¶

Lists all operations that were performed within a specific parent resource.

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

Starts a stopped VM instance.

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

Stops a running VM instance.

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

Updates an existing VM instance with new configuration parameters.

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.compute.v1.UpdateInstanceRequest`	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.compute.v1.In↵
stanceService',
                                                          instance_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.