nebius.api.nebius.iam.v1.FederationServiceClient

class documentation

class FederationServiceClient(ClientWithOperations[Operation, OperationServiceClient]): (source)

Constructor: FederationServiceClient(channel)

This class provides client methods for the nebius.iam.v1.FederationService service.

Class Method	`get_descriptor`	Return the protobuf service descriptor from the registry.
Method	`activate`	Activates an existing federation. By default, a newly created federation is in the active state.
Method	`create`	Creates a federation.
Method	`deactivate`	Deactivates an existing federation. When a federation is inactive, all users under it cannot authenticate.
Method	`delete`	Deletes a federation. An active federation cannot be deleted and must be deactivated first.
Method	`get`	Retrieves information about a federation by ID.
Method	`get_by_name`	Retrieves information about a federation by name and parent container.
Method	`list`	Lists federations by parent container.
Method	`update`	Updates a federation.
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 activate(self, request: ActivateFederationRequest, **kwargs: Unpack[RequestKwargs]) -> Request[ActivateFederationRequest, nebius.aio.operation.Operation[Operation]]: (source) ¶

Activates an existing federation. By default, a newly created federation is in the active state.