class documentation

This class provides client methods for the nebius.compute.v1.InstanceService service.

Class Method get_descriptor Return the protobuf service descriptor from the registry.
Method batch_get Retrieves detailed information about specific VMs by their IDs. If instance cannot be retrieved (e.g. not found) error is returned in place of instance instead.
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. Also deletes all the managed disks, declared in the instance spec. Fails if cannot delete any of the managed disks.
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_instances_by_nvl_instance_group Lists all VM instances that belong to the specified NVL instance group.
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__ 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 __service_name__ Fully qualified protobuf service name for RPC routes.

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.
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) -> object: (source)

Return the protobuf service descriptor from the registry.

def batch_get(self, request: BatchGetRequest, **kwargs: Unpack[RequestKwargs]) -> Request[BatchGetRequest, BatchGetResponse]: (source)

Retrieves detailed information about specific VMs by their IDs. If instance cannot be retrieved (e.g. not found) error is returned in place of instance instead.

The request object is returned without starting the RPC.

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

The request object is returned without starting the RPC.

Deletes a VM instance by its ID. Also deletes all the managed disks, declared in the instance spec. Fails if cannot delete any of the managed disks.

The request object is returned without starting the RPC.

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

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

The request object is returned without starting the RPC.

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

Retrieves detailed information about a specific VM instance by its parent and name.

The request object is returned without starting the RPC.

Lists all VM instances within a specified parent.

The request object is returned without starting the RPC.

Lists all VM instances that belong to the specified NVL instance group.

The request object is returned without starting the RPC.

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

The request object is returned without starting the RPC.

Starts a stopped VM instance.

The request object is returned without starting the RPC.

Stops a running VM instance.

The request object is returned without starting the RPC.

Updates an existing VM instance 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.compute.v1.InstanceService')
__api_service_name__: str = (source)

API gateway name for service routes.

__operation_source_method__: str = (source)

RPC method that supplies the operation route.

__service_name__: str = (source)

Fully qualified protobuf service name for RPC routes.