bigframes.extensions.core.series_accessor.AeadSeriesAccessor#

class bigframes.extensions.core.series_accessor.AeadSeriesAccessor(obj: S)[source]#

Series accessor for BigQuery aead functions.

decrypt_bytes(ciphertext: Series | Expression | Literal[Sentinel.ARGUMENT_DEFAULT] | bytes, additional_data: Series | Expression | Literal[Sentinel.ARGUMENT_DEFAULT] | bytes, *, session: Session | None = None) → S[source]#: Uses the matching key from keyset to decrypt ciphertext and verifies the integrity of the data using additional_data. Returns an error if decryption or verification fails.

decrypt_string(ciphertext: Series | Expression | Literal[Sentinel.ARGUMENT_DEFAULT] | bytes, additional_data: Series | Expression | Literal[Sentinel.ARGUMENT_DEFAULT] | str, *, session: Session | None = None) → S[source]#: Like AEAD.DECRYPT_BYTES, but where additional_data is of type STRING.

encrypt(plaintext: Series | Expression | Literal[Sentinel.ARGUMENT_DEFAULT] | bytes | str, additional_data: Series | Expression | Literal[Sentinel.ARGUMENT_DEFAULT] | bytes | str, *, session: Session | None = None) → S[source]#: Encrypts plaintext using the primary cryptographic key in keyset. The algorithm of the primary key must be AEAD_AES_GCM_256. Binds the ciphertext to the context defined by additional_data. Returns NULL if any input is NULL.