Summary of entries of Classes for bigquerydatapolicy.
Classes
DataPolicyServiceAsyncClient
Data Policy Service provides APIs for managing the label-policy bindings.
DataPolicyServiceClient
Data Policy Service provides APIs for managing the label-policy bindings.
ListDataPoliciesAsyncPager
A pager for iterating through list_data_policies
requests.
This class thinly wraps an initial
ListDataPoliciesResponse object, and
provides an __aiter__
method to iterate through its
data_policies
field.
If there are more pages, the __aiter__
method will make additional
ListDataPolicies
requests and continue to iterate
through the data_policies
field on the
corresponding responses.
All the usual ListDataPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListDataPoliciesPager
A pager for iterating through list_data_policies
requests.
This class thinly wraps an initial
ListDataPoliciesResponse object, and
provides an __iter__
method to iterate through its
data_policies
field.
If there are more pages, the __iter__
method will make additional
ListDataPolicies
requests and continue to iterate
through the data_policies
field on the
corresponding responses.
All the usual ListDataPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
CreateDataPolicyRequest
Request message for the CreateDataPolicy method.
DataMaskingPolicy
The data masking policy that is used to specify data masking rule.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PredefinedExpression
The available masking rules. Learn more here: https://cloud.google.com/bigquery/docs/column-data-masking-intro#masking_options.
- STRING: ""
- BYTES: b''
- INTEGER: 0
- FLOAT: 0.0
- NUMERIC: 0
- BOOLEAN: FALSE
- TIMESTAMP: 1970-01-01 00:00:00 UTC
- DATE: 1970-01-01
- TIME: 00:00:00
- DATETIME: 1970-01-01T00:00:00
- GEOGRAPHY: POINT(0 0)
- BIGNUMERIC: 0
- ARRAY: []
- STRUCT: NOT_APPLICABLE
- JSON: NULL
LAST_FOUR_CHARACTERS (9):
Masking expression shows the last four characters of text.
The masking behavior is as follows:
- If text length > 4 characters: Replace text with XXXXX,
append last four characters of original text.
- If text length <= 4 characters: Apply SHA-256 hash.
FIRST_FOUR_CHARACTERS (10):
Masking expression shows the first four characters of text.
The masking behavior is as follows:
- If text length > 4 characters: Replace text with XXXXX,
prepend first four characters of original text.
- If text length <= 4 characters: Apply SHA-256 hash.
EMAIL_MASK (12):
Masking expression for email addresses. The masking behavior
is as follows:
- Syntax-valid email address: Replace username with XXXXX.
For example, cloudysanfrancisco@gmail.com becomes
XXXXX@gmail.com.
- Syntax-invalid email address: Apply SHA-256 hash.
For more information, see `Email
mask <https://cloud.google.com/bigquery/docs/column-data-masking-intro#masking_options>`__.
DATE_YEAR_MASK (13):
Masking expression to only show the year of `Date`,
`DateTime` and `TimeStamp`. For example, with the year
2076:
- DATE : 2076-01-01
- DATETIME : 2076-01-01T00:00:00
- TIMESTAMP : 2076-01-01 00:00:00 UTC
Truncation occurs according to the UTC time zone. To change
this, adjust the default time zone using the `time_zone`
system variable. For more information, see the System
variables reference.
DataPolicy
Represents the label-policy binding.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DataPolicyType
A list of supported data policy types.
DeleteDataPolicyRequest
Request message for the DeleteDataPolicy method.
GetDataPolicyRequest
Request message for the GetDataPolicy method.
ListDataPoliciesRequest
Request message for the ListDataPolicies method.
ListDataPoliciesResponse
Response message for the ListDataPolicies method.
RenameDataPolicyRequest
Request message for the RenameDataPolicy method.
UpdateDataPolicyRequest
Response message for the UpdateDataPolicy method.
DataPolicyServiceAsyncClient
Data Policy Service provides APIs for managing the label-policy bindings.
DataPolicyServiceClient
Data Policy Service provides APIs for managing the label-policy bindings.
ListDataPoliciesAsyncPager
A pager for iterating through list_data_policies
requests.
This class thinly wraps an initial
ListDataPoliciesResponse object, and
provides an __aiter__
method to iterate through its
data_policies
field.
If there are more pages, the __aiter__
method will make additional
ListDataPolicies
requests and continue to iterate
through the data_policies
field on the
corresponding responses.
All the usual ListDataPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListDataPoliciesPager
A pager for iterating through list_data_policies
requests.
This class thinly wraps an initial
ListDataPoliciesResponse object, and
provides an __iter__
method to iterate through its
data_policies
field.
If there are more pages, the __iter__
method will make additional
ListDataPolicies
requests and continue to iterate
through the data_policies
field on the
corresponding responses.
All the usual ListDataPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
CreateDataPolicyRequest
Request message for the CreateDataPolicy method.
DataMaskingPolicy
The data masking policy that is used to specify data masking rule.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PredefinedExpression
The available masking rules. Learn more here: https://cloud.google.com/bigquery/docs/column-data-masking-intro#masking_options.
- STRING: ""
- BYTES: b''
- INTEGER: 0
- FLOAT: 0.0
- NUMERIC: 0
- BOOLEAN: FALSE
- TIMESTAMP: 0001-01-01 00:00:00 UTC
- DATE: 0001-01-01
- TIME: 00:00:00
- DATETIME: 0001-01-01T00:00:00
- GEOGRAPHY: POINT(0 0)
- BIGNUMERIC: 0
- ARRAY: []
- STRUCT: NOT_APPLICABLE
- JSON: NULL
DataPolicy
Represents the label-policy binding.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DataPolicyType
A list of supported data policy types.
DeleteDataPolicyRequest
Request message for the DeleteDataPolicy method.
GetDataPolicyRequest
Request message for the GetDataPolicy method.
ListDataPoliciesRequest
Request message for the ListDataPolicies method.
ListDataPoliciesResponse
Response message for the ListDataPolicies method.
UpdateDataPolicyRequest
Response message for the UpdateDataPolicy method.
DataPolicyServiceAsyncClient
Data Policy Service provides APIs for managing the BigQuery Data Policy.
DataPolicyServiceClient
Data Policy Service provides APIs for managing the BigQuery Data Policy.
ListDataPoliciesAsyncPager
A pager for iterating through list_data_policies
requests.
This class thinly wraps an initial
ListDataPoliciesResponse object, and
provides an __aiter__
method to iterate through its
data_policies
field.
If there are more pages, the __aiter__
method will make additional
ListDataPolicies
requests and continue to iterate
through the data_policies
field on the
corresponding responses.
All the usual ListDataPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListDataPoliciesPager
A pager for iterating through list_data_policies
requests.
This class thinly wraps an initial
ListDataPoliciesResponse object, and
provides an __iter__
method to iterate through its
data_policies
field.
If there are more pages, the __iter__
method will make additional
ListDataPolicies
requests and continue to iterate
through the data_policies
field on the
corresponding responses.
All the usual ListDataPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
AddGranteesRequest
Request message for the AddGrantees method.
CreateDataPolicyRequest
Request message for the CreateDataPolicy method.
DataMaskingPolicy
The policy used to specify data masking rule.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PredefinedExpression
The available masking rules. Learn more here: https://cloud.google.com/bigquery/docs/column-data-masking-intro#masking_options.
- STRING: ""
- BYTES: b''
- INTEGER: 0
- FLOAT: 0.0
- NUMERIC: 0
- BOOLEAN: FALSE
- TIMESTAMP: 1970-01-01 00:00:00 UTC
- DATE: 1970-01-01
- TIME: 00:00:00
- DATETIME: 1970-01-01T00:00:00
- GEOGRAPHY: POINT(0 0)
- BIGNUMERIC: 0
- ARRAY: []
- STRUCT: NOT_APPLICABLE
- JSON: NULL
LAST_FOUR_CHARACTERS (4):
Masking expression shows the last four characters of text.
The masking behavior is as follows:
- If text length > 4 characters: Replace text with XXXXX,
append last four characters of original text.
- If text length <= 4 characters: Apply SHA-256 hash.
FIRST_FOUR_CHARACTERS (5):
Masking expression shows the first four characters of text.
The masking behavior is as follows:
- If text length > 4 characters: Replace text with XXXXX,
prepend first four characters of original text.
- If text length <= 4 characters: Apply SHA-256 hash.
EMAIL_MASK (6):
Masking expression for email addresses. The masking behavior
is as follows:
- Syntax-valid email address: Replace username with XXXXX.
For example, cloudysanfrancisco@gmail.com becomes
XXXXX@gmail.com.
- Syntax-invalid email address: Apply SHA-256 hash.
For more information, see `Email
mask <https://cloud.google.com/bigquery/docs/column-data-masking-intro#masking_options>`__.
DATE_YEAR_MASK (7):
Masking expression to only show the year of `Date`,
`DateTime` and `TimeStamp`. For example, with the year
2076:
- DATE : 2076-01-01
- DATETIME : 2076-01-01T00:00:00
- TIMESTAMP : 2076-01-01 00:00:00 UTC
Truncation occurs according to the UTC time zone. To change
this, adjust the default time zone using the `time_zone`
system variable. For more information, see `System variables
reference <https://cloud.google.com/bigquery/docs/reference/system-variables>`__.
RANDOM_HASH (8):
Masking expression that uses hashing to mask
column data. It differs from SHA256 in that a
unique random value is generated for each query
and is added to the hash input, resulting in the
hash / masked result to be different for each
query. Hence the name "random hash".
DataPolicy
Represents the label-policy binding.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DataPolicyType
A list of supported data policy types.
Version
The supported versions for the Data Policy resource.
DeleteDataPolicyRequest
Request message for the DeleteDataPolicy method.
GetDataPolicyRequest
Request message for the GetDataPolicy method.
ListDataPoliciesRequest
Request message for the ListDataPolicies method.
ListDataPoliciesResponse
Response message for the ListDataPolicies method.
RemoveGranteesRequest
Request message for the RemoveGrantees method.
UpdateDataPolicyRequest
Request message for the UpdateDataPolicy method.
DataPolicyServiceAsyncClient
Data Policy Service provides APIs for managing the BigQuery Data Policy.
DataPolicyServiceClient
Data Policy Service provides APIs for managing the BigQuery Data Policy.
ListDataPoliciesAsyncPager
A pager for iterating through list_data_policies
requests.
This class thinly wraps an initial
ListDataPoliciesResponse object, and
provides an __aiter__
method to iterate through its
data_policies
field.
If there are more pages, the __aiter__
method will make additional
ListDataPolicies
requests and continue to iterate
through the data_policies
field on the
corresponding responses.
All the usual ListDataPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListDataPoliciesPager
A pager for iterating through list_data_policies
requests.
This class thinly wraps an initial
ListDataPoliciesResponse object, and
provides an __iter__
method to iterate through its
data_policies
field.
If there are more pages, the __iter__
method will make additional
ListDataPolicies
requests and continue to iterate
through the data_policies
field on the
corresponding responses.
All the usual ListDataPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
AddGranteesRequest
Request message for the AddGrantees method.
CreateDataPolicyRequest
Request message for the CreateDataPolicy method.
DataMaskingPolicy
The policy used to specify data masking rule.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PredefinedExpression
The available masking rules. Learn more here: https://cloud.google.com/bigquery/docs/column-data-masking-intro#masking_options.
- STRING: ""
- BYTES: b''
- INTEGER: 0
- FLOAT: 0.0
- NUMERIC: 0
- BOOLEAN: FALSE
- TIMESTAMP: 1970-01-01 00:00:00 UTC
- DATE: 1970-01-01
- TIME: 00:00:00
- DATETIME: 1970-01-01T00:00:00
- GEOGRAPHY: POINT(0 0)
- BIGNUMERIC: 0
- ARRAY: []
- STRUCT: NOT_APPLICABLE
- JSON: NULL
DataPolicy
Represents the label-policy binding.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DataPolicyType
A list of supported data policy types.
Version
The supported versions for the Data Policy resource.
DeleteDataPolicyRequest
Request message for the DeleteDataPolicy method.
GetDataPolicyRequest
Request message for the GetDataPolicy method.
ListDataPoliciesRequest
Request message for the ListDataPolicies method.
ListDataPoliciesResponse
Response message for the ListDataPolicies method.
RemoveGranteesRequest
Request message for the RemoveGrantees method.
UpdateDataPolicyRequest
Request message for the UpdateDataPolicy method.
Modules
pagers
API documentation for bigquery_datapolicies_v1.services.data_policy_service.pagers
module.
pagers
API documentation for bigquery_datapolicies_v1beta1.services.data_policy_service.pagers
module.
pagers
API documentation for bigquery_datapolicies_v2.services.data_policy_service.pagers
module.
pagers
API documentation for bigquery_datapolicies_v2beta1.services.data_policy_service.pagers
module.