target.apidocs.com.google.api.services.bigquery.model.DifferentialPrivacyPolicy.html Maven / Gradle / Ivy
DifferentialPrivacyPolicy (BigQuery API v2-rev20240905-2.0.0)
com.google.api.services.bigquery.model
Class DifferentialPrivacyPolicy
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.bigquery.model.DifferentialPrivacyPolicy
-
public final class DifferentialPrivacyPolicy
extends com.google.api.client.json.GenericJson
Represents privacy policy associated with "differential privacy" method.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the BigQuery API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
DifferentialPrivacyPolicy()
-
Method Summary
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getDeltaBudget
public Double getDeltaBudget()
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.
- Returns:
- value or
null for none
-
setDeltaBudget
public DifferentialPrivacyPolicy setDeltaBudget(Double deltaBudget)
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.
- Parameters:
deltaBudget - deltaBudget or null for none
-
getDeltaBudgetRemaining
public Double getDeltaBudgetRemaining()
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.
- Returns:
- value or
null for none
-
setDeltaBudgetRemaining
public DifferentialPrivacyPolicy setDeltaBudgetRemaining(Double deltaBudgetRemaining)
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.
- Parameters:
deltaBudgetRemaining - deltaBudgetRemaining or null for none
-
getDeltaPerQuery
public Double getDeltaPerQuery()
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.
- Returns:
- value or
null for none
-
setDeltaPerQuery
public DifferentialPrivacyPolicy setDeltaPerQuery(Double deltaPerQuery)
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.
- Parameters:
deltaPerQuery - deltaPerQuery or null for none
-
getEpsilonBudget
public Double getEpsilonBudget()
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.
- Returns:
- value or
null for none
-
setEpsilonBudget
public DifferentialPrivacyPolicy setEpsilonBudget(Double epsilonBudget)
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.
- Parameters:
epsilonBudget - epsilonBudget or null for none
-
getEpsilonBudgetRemaining
public Double getEpsilonBudgetRemaining()
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.
- Returns:
- value or
null for none
-
setEpsilonBudgetRemaining
public DifferentialPrivacyPolicy setEpsilonBudgetRemaining(Double epsilonBudgetRemaining)
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.
- Parameters:
epsilonBudgetRemaining - epsilonBudgetRemaining or null for none
-
getMaxEpsilonPerQuery
public Double getMaxEpsilonPerQuery()
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.
- Returns:
- value or
null for none
-
setMaxEpsilonPerQuery
public DifferentialPrivacyPolicy setMaxEpsilonPerQuery(Double maxEpsilonPerQuery)
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.
- Parameters:
maxEpsilonPerQuery - maxEpsilonPerQuery or null for none
-
getMaxGroupsContributed
public Long getMaxGroupsContributed()
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.
- Returns:
- value or
null for none
-
setMaxGroupsContributed
public DifferentialPrivacyPolicy setMaxGroupsContributed(Long maxGroupsContributed)
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.
- Parameters:
maxGroupsContributed - maxGroupsContributed or null for none
-
getPrivacyUnitColumn
public String getPrivacyUnitColumn()
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).
- Returns:
- value or
null for none
-
setPrivacyUnitColumn
public DifferentialPrivacyPolicy setPrivacyUnitColumn(String privacyUnitColumn)
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).
- Parameters:
privacyUnitColumn - privacyUnitColumn or null for none
-
set
public DifferentialPrivacyPolicy set(String fieldName,
Object value)
- Overrides:
set in class com.google.api.client.json.GenericJson
-
clone
public DifferentialPrivacyPolicy clone()
- Overrides:
clone in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.