nebius.api.nebius.kms.v1.SymmetricKeyServiceClient

class documentation

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

Constructor: SymmetricKeyServiceClient(channel)

View In Hierarchy

Set of methods for managing symmetric KMS keys.

This class provides client methods for the nebius.kms.v1.SymmetricKeyService service.

Class Method get_descriptor Return the protobuf service descriptor from the registry.
Method create Creates a symmetric KMS key in the specified container.
Method delete Schedules a symmetric KMS key for deletion.
Method get Returns the specified symmetric KMS key by id.
Method get_by_name Returns the specified symmetric KMS key by name.
Method list Returns the list of symmetric KMS keys in the specified container.
Method operation_service Return the client that manages long-running operations.
Method rotate Rotates the specified key: creates a new key version and makes it the primary version. The old version remains available for decryption of ciphertext encrypted with it.
Method undelete Restores a symmetric KMS key scheduled for deletion.
Method update Updates a symmetric KMS key.
Method update_deletion_delay Update deletion delay for a symmetric KMS key scheduled for deletion.
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 create(self, request: CreateSymmetricKeyRequest, **kwargs: Unpack[RequestKwargs]) -> Request[CreateSymmetricKeyRequest, nebius.aio.operation.Operation[Operation]]: (source)

Creates a symmetric KMS key in the specified container.

The request object is returned without starting the RPC.

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

Schedules a symmetric KMS key for deletion.

The request object is returned without starting the RPC.

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

Returns the specified symmetric KMS key by id.

The request object is returned without starting the RPC.

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

Returns the specified symmetric KMS key by name.

The request object is returned without starting the RPC.

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

Returns the list of symmetric KMS keys in the specified 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 rotate(self, request: RotateSymmetricKeyRequest, **kwargs: Unpack[RequestKwargs]) -> Request[RotateSymmetricKeyRequest, nebius.aio.operation.Operation[Operation]]: (source)

Rotates the specified key: creates a new key version and makes it the primary version. The old version remains available for decryption of ciphertext encrypted with it.

The request object is returned without starting the RPC.

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

Restores a symmetric KMS key scheduled for deletion.

The request object is returned without starting the RPC.

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

Updates a symmetric KMS key.

The request object is returned without starting the RPC.

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

Update deletion delay for a symmetric KMS key scheduled for deletion.

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.kms.v1.SymmetricKeyService')
__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