nebius.api.nebius.kms.v1.SymmetricKeyServiceClient

class documentation

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

Constructor: SymmetricKeyServiceClient(channel)

View In Hierarchy

Set of methods for managing symmetric KMS keys.

This class provides the client methods for the .nebius.kms.v1.SymmetricKeyService 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 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 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__ 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 create(self, request: CreateSymmetricKeyRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[CreateSymmetricKeyRequest, operation.Operation[v1_1.Operation]]: (source)

Creates a symmetric KMS key in the specified 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.kms.v1.CreateSymmetricKeyRequestThe 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: DeleteSymmetricKeyRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[DeleteSymmetricKeyRequest, operation.Operation[v1_1.Operation]]: (source)

Schedules a symmetric KMS key for deletion.

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.kms.v1.DeleteSymmetricKeyRequestThe 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: GetSymmetricKeyRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[GetSymmetricKeyRequest, SymmetricKey]: (source)

Returns the specified symmetric KMS key 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.kms.v1.GetSymmetricKeyRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.kms.v1.SymmetricKey.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: GetSymmetricKeyByNameRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[GetSymmetricKeyByNameRequest, SymmetricKey]: (source)

Returns the specified symmetric KMS key by name.

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.kms.v1.GetSymmetricKeyByNameRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.kms.v1.SymmetricKey.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: ListSymmetricKeysRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[ListSymmetricKeysRequest, ListSymmetricKeysResponse]: (source)

Returns the list of symmetric KMS keys in the specified 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.kms.v1.ListSymmetricKeysRequestThe request object to send.
**kwargs:typing_extensions.Unpack[request_kwargs.RequestKwargs]Undocumented
Returns
nebius.aio.request.Request of nebius.api.nebius.kms.v1.ListSymmetricKeysResponse.A nebius.aio.request.Request object representing the in-flight RPC. It can be awaited (async) or waited synchronously using its .wait() helpers.
def rotate(self, request: RotateSymmetricKeyRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[RotateSymmetricKeyRequest, operation.Operation[v1_1.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.

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.kms.v1.RotateSymmetricKeyRequestThe 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 undelete(self, request: UndeleteSymmetricKeyRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[UndeleteSymmetricKeyRequest, operation.Operation[v1_1.Operation]]: (source)

Restores a symmetric KMS key scheduled for deletion.

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.kms.v1.UndeleteSymmetricKeyRequestThe 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 update(self, request: UpdateSymmetricKeyRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[UpdateSymmetricKeyRequest, operation.Operation[v1_1.Operation]]: (source)

Updates a symmetric KMS key.

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.kms.v1.UpdateSymmetricKeyRequestThe 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 update_deletion_delay(self, request: UpdateSymmetricKeyDeletionDelayRequest, **kwargs: typing_extensions.Unpack[request_kwargs.RequestKwargs]) -> request_1.Request[UpdateSymmetricKeyDeletionDelayRequest, operation.Operation[v1_1.Operation]]: (source)

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

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.kms.v1.UpdateSymmetricKeyDeletionDelayRequestThe 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.kms.v1.Symmet↵
ricKeyService',
                                                          symmetric_key_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.