nebius.api.nebius.compute.v1.InstanceServiceClient

class documentation

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

Constructor: InstanceServiceClient(channel)

Undocumented

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__`	Undocumented
Class Variable	`__operation_source_method__`	Undocumented
Class Variable	`__service_name__`	Undocumented

Inherited from ClientWithOperations:

Method	`__init__`	Undocumented
Method	`operation_service`	Undocumented
Class Variable	`__operation_service_class__`	Undocumented
Class Variable	`__operation_type__`	Undocumented
Instance Variable	`__operation_service__`	Undocumented

Inherited from Client (via ClientWithOperations):

Method	`request`	Undocumented
Instance Variable	`_channel`	Undocumented

def create(self, request: CreateInstanceRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> 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

def delete(self, request: DeleteInstanceRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[DeleteInstanceRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Deletes a VM instance by its ID.

def get(self, request: GetInstanceRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[GetInstanceRequest, Instance]: (source) ¶

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

def get_by_name(self, request: v1_1.GetByNameRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[v1_1.GetByNameRequest, Instance]: (source) ¶

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

def list(self, request: ListInstancesRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[ListInstancesRequest, ListInstancesResponse]: (source) ¶

Lists all VM instances within a specified parent.

def list_operations_by_parent(self, request: ListOperationsByParentRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[ListOperationsByParentRequest, v1_1.ListOperationsResponse]: (source) ¶

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

def start(self, request: StartInstanceRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[StartInstanceRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Starts a stopped VM instance.

def stop(self, request: StopInstanceRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[StopInstanceRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Stops a running VM instance.

def update(self, request: UpdateInstanceRequest, metadata: abc.Iterable[builtins.tuple[builtins.str, builtins.str]] | None = None, timeout: builtins.float | None = None, credentials: grpc.CallCredentials | None = None, compression: grpc.Compression | None = None, retries: builtins.int | None = 3, per_retry_timeout: builtins.float | None = None) -> request_1.Request[UpdateInstanceRequest, operation.Operation[v1_1.Operation]]: (source) ¶

Updates an existing VM instance with new configuration parameters.

__PB2_DESCRIPTOR__ = (source) ¶

Undocumented

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__

Undocumented

__service_name__: str = (source) ¶

overrides nebius.aio.client.Client.__service_name__

Undocumented