nebius.api.nebius.mysterybox.v1.GetPayloadByKeyRequest

class documentation

class GetPayloadByKeyRequest(pb_classes.Message): (source)

Constructor: GetPayloadByKeyRequest(initial_message, secret_id, version_id, key)

Undocumented

Method	`__dir__`	Undocumented
Method	`__init__`	Create a wrapper around a protobuf message instance.
Method	`key.setter`	Undocumented
Method	`secret_id.setter`	Undocumented
Method	`version_id.setter`	Undocumented
Constant	`__PB2_DESCRIPTOR__`	Undocumented
Constant	`__PY_TO_PB2__`	Undocumented
Class Variable	`__mask_functions__`	Undocumented
Property	`key`	Payload's key to be retrieved.
Property	`secret_id`	Undocumented
Property	`version_id`	Desired version of the secret. If not provided, the primary version of the secret will be returned.

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.

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

Undocumented

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

Undocumented

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

Undocumented

__PB2_DESCRIPTOR__ = (source) ¶

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

Undocumented

Value

descriptor.DescriptorWrap[descriptor_1.Descriptor]('.nebius.mysterybox.v1.GetPay↵
loadByKeyRequest',
                                                   payload_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

{'secret_id': 'secret_id', 'version_id': 'version_id', 'key': 'key'}

__mask_functions__: dict = (source) ¶

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

Undocumented

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

Payload's key to be retrieved.

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

Undocumented

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

Desired version of the secret. If not provided, the primary version of the secret will be returned.