nebius.api.nebius.kms.v1.GenerateDataKeyRequest

class documentation

class GenerateDataKeyRequest(pb_classes.Message): (source)

Constructor: GenerateDataKeyRequest(initial_message, key_id, aad_context, data_key_spec, ...)

Undocumented

Method	`__dir__`	Undocumented
Method	`__init__`	Create a wrapper around a protobuf message instance.
Method	`aad_context.setter`	Undocumented
Method	`data_key_spec.setter`	Undocumented
Method	`key_id.setter`	Undocumented
Method	`skip_plaintext.setter`	Undocumented
Constant	`__PB2_DESCRIPTOR__`	Undocumented
Constant	`__PY_TO_PB2__`	Undocumented
Class Variable	`__mask_functions__`	Undocumented
Property	`aad_context`	Additional authenticated data (AAD context), optional. If specified, this data will be required for decryption with the [SymmetricDecryptRequest]. Should be encoded with base64.
Property	`data_key_spec`	Encryption algorithm and key length for the generated data key.
Property	`key_id`	ID of the symmetric KMS key that the generated data key should be encrypted with.
Property	`skip_plaintext`	If `true`, the method won't return the data key as plaintext. Default value is `false`.

Inherited from Message:

Class Method	`get_descriptor`	Return the protobuf descriptor for this message class.
Class Method	`is_credentials`	Return True if the field contains credentials.
Class Method	`is_sensitive`	Return True if the field is marked as sensitive.
Method	`__repr__`	Return a human-readable representation of the message, sanitizing sensitive fields.
Method	`check_presence`	Check explicit presence for a field in the protobuf message.
Method	`get_full_update_reset_mask`	Build a reset mask for a full update of this message.
Method	`get_mask`	Return the tracked reset mask.
Method	`is_default`	Return True if a field equals its default value.
Method	`set_mask`	Replace the tracked reset mask.
Method	`which_field_in_oneof`	Return the set field name for a given oneof.
Instance Variable	`__PB2_CLASS__`	Protobuf message class associated with this wrapper.
Instance Variable	`__pb2_message__`	Underlying protobuf message instance.
Method	`_clear_field`	Clear a field and record it in the reset mask.
Method	`_get_field`	Return a field value with optional wrapping and presence handling.
Method	`_set_field`	Set a field value and update the reset mask.
Class Variable	`__credentials_fields`	Undocumented
Class Variable	`__default`	Undocumented
Class Variable	`__sensitive_fields`	Undocumented
Instance Variable	`__recorded_reset_mask`	Mask tracking fields cleared or set to default.

def __dir__(self) -> abc.Iterable[builtins.str]: (source) ¶

Undocumented

overrides nebius.base.protos.pb_classes.Message.__init__

Create a wrapper around a protobuf message instance.

Raises
`AttributeError`	If the wrapper is missing required class metadata.

@aad_context.setter
def aad_context(self, value: builtins.bytes | None): (source) ¶

Undocumented

@data_key_spec.setter
def data_key_spec(self, value: SymmetricAlgorithm | symmetric_key_pb2.SymmetricAlgorithm | None): (source) ¶

Undocumented

@key_id.setter
def key_id(self, value: builtins.str | None): (source) ¶

Undocumented

@skip_plaintext.setter
def skip_plaintext(self, value: builtins.bool | None): (source) ¶

Undocumented

__PB2_DESCRIPTOR__ = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__PB2_DESCRIPTOR__

Undocumented

Value

descriptor.DescriptorWrap[descriptor_1.Descriptor]('.nebius.kms.v1.GenerateDataK↵
eyRequest',
                                                   symmetric_crypto_service_pb2.DESCRIPTOR↵
,
                                                   descriptor_1.Descriptor)

__PY_TO_PB2__: builtins.dict[builtins.str, builtins.str] = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__PY_TO_PB2__

Undocumented

Value

{'key_id': 'key_id',
 'aad_context': 'aad_context',
 'data_key_spec': 'data_key_spec',
 'skip_plaintext': 'skip_plaintext'}

__mask_functions__: dict = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__mask_functions__

Undocumented

@builtins.property
aad_context: builtins.bytes = (source) ¶

Additional authenticated data (AAD context), optional. If specified, this data will be required for decryption with the [SymmetricDecryptRequest]. Should be encoded with base64.

@builtins.property
data_key_spec: SymmetricAlgorithm = (source) ¶

Encryption algorithm and key length for the generated data key.

@builtins.property
key_id: builtins.str = (source) ¶

ID of the symmetric KMS key that the generated data key should be encrypted with.

@builtins.property
skip_plaintext: builtins.bool = (source) ¶

If true, the method won't return the data key as plaintext. Default value is false.