nebius.api.nebius.iam.v1.FederationServiceClient

class documentation

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

Constructor: FederationServiceClient(channel)

View In Hierarchy

This class provides the client methods for the .nebius.iam.v1.FederationService 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 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__ The protobuf service descriptor extraction function.
Class Variable __operation_source_method__ The method name that can be used to fetch the address channel for the operation.
Class Variable __service_name__ The full protobuf service name.

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.
Class Variable __service_deprecation_details__ optional deprecation message emitted as a runtime warning when the client is constructed.
Instance Variable _channel Undocumented
def activate(self, request: ActivateFederationRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[ActivateFederationRequest, operation_1.Operation[v1_1.Operation]]: (source)

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

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.iam.v1.ActivateFederationRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1.Operation.A nebius.aio.request.Request object representing the in-flight RPC. It can be awaited (async) or waited synchronously using its .wait() helpers.
def create(self, request: CreateFederationRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[CreateFederationRequest, operation_1.Operation[v1_1.Operation]]: (source)

Creates a federation.

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.iam.v1.CreateFederationRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1.Operation.A nebius.aio.request.Request object representing the in-flight RPC. It can be awaited (async) or waited synchronously using its .wait() helpers.
def deactivate(self, request: DeactivateFederationRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[DeactivateFederationRequest, operation_1.Operation[v1_1.Operation]]: (source)

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

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.iam.v1.DeactivateFederationRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1.Operation.A nebius.aio.request.Request object representing the in-flight RPC. It can be awaited (async) or waited synchronously using its .wait() helpers.
def delete(self, request: DeleteFederationRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[DeleteFederationRequest, operation_1.Operation[v1_1.Operation]]: (source)

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

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.iam.v1.DeleteFederationRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1.Operation.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(self, request: GetFederationRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[GetFederationRequest, Federation]: (source)

Retrieves information about a federation by 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.iam.v1.GetFederationRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.iam.v1.Federation.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_name(self, request: v1_1.GetByNameRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[v1_1.GetByNameRequest, Federation]: (source)

Retrieves information about a federation by name and parent container.

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.common.v1.GetByNameRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.iam.v1.Federation.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: ListFederationsRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[ListFederationsRequest, ListFederationsResponse]: (source)

Lists federations by parent container.

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.iam.v1.ListFederationsRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.iam.v1.ListFederationsResponse.A nebius.aio.request.Request object representing the in-flight RPC. It can be awaited (async) or waited synchronously using its .wait() helpers.
def update(self, request: UpdateFederationRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[UpdateFederationRequest, operation_1.Operation[v1_1.Operation]]: (source)

Updates a federation.

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.iam.v1.UpdateFederationRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.common.v1.Operation.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.iam.v1.Federa↵
tionService',
                                                          federation_service_pb2.DESCRIPTOR↵
,
                                                          descriptor_1.ServiceDescriptor↵
)
__operation_source_method__: str = (source)
overrides nebius.aio.client.ClientWithOperations.__operation_source_method__

The method name that can be used to fetch the address channel for the operation.

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

The full protobuf service name.