nebius.api.nebius.capacity.v1.CapacityBlockGroupServiceClient

class documentation

class CapacityBlockGroupServiceClient(client.Client): (source)

Constructor: CapacityBlockGroupServiceClient(channel)

Capacity Block Group service provides read access to Capacity Block Groups resources.

This class provides the client methods for the .nebius.capacity.v1.CapacityBlockGroupService 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	`get`	Get Capacity Block Group by its ID.
Method	`get_by_resource_affinity`	Get Capacity Block Group by its specification.
Method	`list`	List all Capacity Block Groups for the specified Tenant.
Method	`list_resources`	List virtual machines instances' IDs that occupy a Capacity Block Group by its ID.
Constant	`__PB2_DESCRIPTOR__`	The protobuf service descriptor extraction function.
Class Variable	`__service_name__`	The full protobuf service name.

Inherited from Client:

Method	`__init__`	Create a client bound to a channel.
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 get(self, request: GetCapacityBlockGroupRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request.Request[GetCapacityBlockGroupRequest, CapacityBlockGroup]: (source) ¶

Get Capacity Block Group 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.capacity.v1.GetCapacityBlockGroupRequest`	The request object to send.
**kwargs:`typing_extensions.Unpack[request_kwargs.RequestKwargs]`	Undocumented
Returns
`nebius.aio.request.Request` of `nebius.api.nebius.capacity.v1.CapacityBlockGroup`.	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_resource_affinity(self, request: GetCapacityBlockGroupByResourceAffinityRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request.Request[GetCapacityBlockGroupByResourceAffinityRequest, CapacityBlockGroup]: (source) ¶

Get Capacity Block Group by its specification.

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

List all Capacity Block Groups for the specified Tenant.

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.capacity.v1.ListCapacityBlockGroupsRequest`	The request object to send.
**kwargs:`typing_extensions.Unpack[request_kwargs.RequestKwargs]`	Undocumented
Returns
`nebius.aio.request.Request` of `nebius.api.nebius.capacity.v1.ListCapacityBlockGroupsResponse`.	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_resources(self, request: ListCapacityBlockGroupResourcesRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request.Request[ListCapacityBlockGroupResourcesRequest, ListCapacityBlockGroupResourcesResponse]: (source) ¶

List virtual machines instances' IDs that occupy a Capacity Block Group 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.capacity.v1.ListCapacityBlockGroupResourcesRequest`	The request object to send.
**kwargs:`typing_extensions.Unpack[request_kwargs.RequestKwargs]`	Undocumented
Returns
`nebius.aio.request.Request` of `nebius.api.nebius.capacity.v1.ListCapacityBlockGroupResourcesResponse`.	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.capacity.v1.C↵
apacityBlockGroupService',
                                                          capacity_block_group_service_pb2.DESCRIPTOR↵
,
                                                          descriptor_1.ServiceDescriptor↵
)

__service_name__: str = (source) ¶

overrides nebius.aio.client.Client.__service_name__

The full protobuf service name.