Struct google_api_proto::google::cloud::bigquery::v2::DifferentialPrivacyPolicy

pub struct DifferentialPrivacyPolicy {
    pub max_epsilon_per_query: Option<f64>,
    pub delta_per_query: Option<f64>,
    pub max_groups_contributed: Option<i64>,
    pub privacy_unit_column: Option<String>,
    pub epsilon_budget: Option<f64>,
    pub delta_budget: Option<f64>,
    pub epsilon_budget_remaining: Option<f64>,
    pub delta_budget_remaining: Option<f64>,
}

Represents privacy policy associated with “differential privacy” method.

Fields

max_epsilon_per_query: Option<f64>

Optional. The maximum epsilon value that a query can consume. If the subscriber specifies epsilon as a parameter in a SELECT query, it must be less than or equal to this value. The epsilon parameter controls the amount of noise that is added to the groups — a higher epsilon means less noise.

delta_per_query: Option<f64>

Optional. The delta value that is used per query. Delta represents the probability that any row will fail to be epsilon differentially private. Indicates the risk associated with exposing aggregate rows in the result of a query.

max_groups_contributed: Option<i64>

Optional. The maximum groups contributed value that is used per query. Represents the maximum number of groups to which each protected entity can contribute. Changing this value does not improve or worsen privacy. The best value for accuracy and utility depends on the query and data.

privacy_unit_column: Option<String>

Optional. The privacy unit column associated with this policy. Differential privacy policies can only have one privacy unit column per data source object (table, view).

epsilon_budget: Option<f64>

Optional. The total epsilon budget for all queries against the privacy-protected view. Each subscriber query against this view charges the amount of epsilon they request in their query. If there is sufficient budget, then the subscriber query attempts to complete. It might still fail due to other reasons, in which case the charge is refunded. If there is insufficient budget the query is rejected. There might be multiple charge attempts if a single query references multiple views. In this case there must be sufficient budget for all charges or the query is rejected and charges are refunded in best effort. The budget does not have a refresh policy and can only be updated via ALTER VIEW or circumvented by creating a new view that can be queried with a fresh budget.

delta_budget: Option<f64>

Optional. The total delta budget for all queries against the privacy-protected view. Each subscriber query against this view charges the amount of delta that is pre-defined by the contributor through the privacy policy delta_per_query field. If there is sufficient budget, then the subscriber query attempts to complete. It might still fail due to other reasons, in which case the charge is refunded. If there is insufficient budget the query is rejected. There might be multiple charge attempts if a single query references multiple views. In this case there must be sufficient budget for all charges or the query is rejected and charges are refunded in best effort. The budget does not have a refresh policy and can only be updated via ALTER VIEW or circumvented by creating a new view that can be queried with a fresh budget.

epsilon_budget_remaining: Option<f64>

Output only. The epsilon budget remaining. If budget is exhausted, no more queries are allowed. Note that the budget for queries that are in progress is deducted before the query executes. If the query fails or is cancelled then the budget is refunded. In this case the amount of budget remaining can increase.

delta_budget_remaining: Option<f64>

Output only. The delta budget remaining. If budget is exhausted, no more queries are allowed. Note that the budget for queries that are in progress is deducted before the query executes. If the query fails or is cancelled then the budget is refunded. In this case the amount of budget remaining can increase.

Implementations

impl DifferentialPrivacyPolicy

pub fn max_epsilon_per_query(&self) -> f64

Returns the value of max_epsilon_per_query, or the default value if max_epsilon_per_query is unset.

pub fn delta_per_query(&self) -> f64

Returns the value of delta_per_query, or the default value if delta_per_query is unset.

pub fn max_groups_contributed(&self) -> i64

Returns the value of max_groups_contributed, or the default value if max_groups_contributed is unset.

pub fn privacy_unit_column(&self) -> &str

Returns the value of privacy_unit_column, or the default value if privacy_unit_column is unset.

pub fn epsilon_budget(&self) -> f64

Returns the value of epsilon_budget, or the default value if epsilon_budget is unset.

pub fn delta_budget(&self) -> f64

Returns the value of delta_budget, or the default value if delta_budget is unset.

pub fn epsilon_budget_remaining(&self) -> f64

Returns the value of epsilon_budget_remaining, or the default value if epsilon_budget_remaining is unset.

pub fn delta_budget_remaining(&self) -> f64

Returns the value of delta_budget_remaining, or the default value if delta_budget_remaining is unset.

Trait Implementations

impl Clone for DifferentialPrivacyPolicy

fn clone(&self) -> DifferentialPrivacyPolicy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DifferentialPrivacyPolicy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DifferentialPrivacyPolicy

fn default() -> Self

Returns the “default value” for a type.

impl Message for DifferentialPrivacyPolicy

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for DifferentialPrivacyPolicy

fn eq(&self, other: &DifferentialPrivacyPolicy) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DifferentialPrivacyPolicy