nebius.api.nebius.iam.v1.FederationServiceClient

class documentation

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

Constructor: FederationServiceClient(channel)

View In Hierarchy

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 operation_service Return the client that manages long-running operations.
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 __operation_type__ Message type representing a long-running operation.
Class Variable __service_name__ Fully qualified protobuf service name for RPC routes.
Instance Variable __operation_service__ Undocumented

Inherited from ClientWithOperations:

Method __init__ Initialize the client-with-operations.
Class Variable __operation_service_class__ the client class used to manage operations.

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

The request object is returned without starting the RPC.

def create(self, request: CreateFederationRequest, **kwargs: Unpack[RequestKwargs]) -> Request[CreateFederationRequest, nebius.aio.operation.Operation[Operation]]: (source)

Creates a federation.

The request object is returned without starting the RPC.

def deactivate(self, request: DeactivateFederationRequest, **kwargs: Unpack[RequestKwargs]) -> Request[DeactivateFederationRequest, nebius.aio.operation.Operation[Operation]]: (source)

Deactivates an existing federation. When a federation is inactive, all users under it cannot authenticate.

The request object is returned without starting the RPC.

def delete(self, request: DeleteFederationRequest, **kwargs: Unpack[RequestKwargs]) -> Request[DeleteFederationRequest, nebius.aio.operation.Operation[Operation]]: (source)

Deletes a federation. An active federation cannot be deleted and must be deactivated first.

The request object is returned without starting the RPC.

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

Retrieves information about a federation by ID.

The request object is returned without starting the RPC.

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

Retrieves information about a federation by name and parent container.

The request object is returned without starting the RPC.

def list(self, request: ListFederationsRequest, **kwargs: Unpack[RequestKwargs]) -> Request[ListFederationsRequest, ListFederationsResponse]: (source)

Lists federations by parent container.

The request object is returned without starting the RPC.

def operation_service(self): (source)
overrides nebius.aio.client.ClientWithOperations.operation_service

Return the client that manages long-running operations.

def update(self, request: UpdateFederationRequest, **kwargs: Unpack[RequestKwargs]) -> Request[UpdateFederationRequest, nebius.aio.operation.Operation[Operation]]: (source)

Updates a federation.

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.iam.v1.FederationService')
__api_service_name__: str = (source)
overrides nebius.aio.client.Client.__api_service_name__

API gateway name for service routes.

__operation_source_method__: str = (source)
overrides nebius.aio.client.ClientWithOperations.__operation_source_method__

RPC method that supplies the operation route.

__operation_type__ = (source)
overrides nebius.aio.client.ClientWithOperations.__operation_type__

Message type representing a long-running operation.

__service_name__: str = (source)
overrides nebius.aio.client.Client.__service_name__

Fully qualified protobuf service name for RPC routes.

__operation_service__ = (source)
overrides nebius.aio.client.ClientWithOperations.__operation_service__

Undocumented