Reference documentation and code samples for the Google Cloud Chronicle V1 Client class DataAccessScope.
A DataAccessScope is a boolean expression of data access labels used to restrict access to data for users.
Generated from protobuf message google.cloud.chronicle.v1.DataAccessScope
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The unique full name of the data access scope. The name should comply with https://google.aip.dev/122 standards.
↳ allowed_data_access_labels
array< DataAccessLabelReference
>
Optional. The allowed labels for the scope. Either allow_all or allowed_data_access_labels needs to be provided. When provided, there has to be at least one label allowed for the scope to be valid. The logical operator for evaluation of the allowed labels is OR. E.g.: A customer with scope with allowed labels A and B will be able to see data with labeled with A or B or (A and B).
↳ denied_data_access_labels
array< DataAccessLabelReference
>
Optional. The denied labels for the scope. The logical operator for evaluation of the denied labels is AND. E.g.: A customer with scope with denied labels A and B won't be able to see data labeled with A and data labeled with B and data with labels A and B.
↳ display_name
string
Output only. The name to be used for display to customers of the data access scope.
↳ create_time
↳ update_time
↳ author
string
Output only. The user who created the data access scope.
↳ last_editor
string
Output only. The user who last updated the data access scope.
↳ description
string
Optional. A description of the data access scope for a human reader.
↳ allow_all
bool
Optional. Whether or not the scope allows all labels, allow_all and allowed_data_access_labels are mutually exclusive and one of them must be present. denied_data_access_labels can still be used along with allow_all. When combined with denied_data_access_labels, access will be granted to all data that doesn't have labels mentioned in denied_data_access_labels. E.g.: A customer with scope with denied labels A and B and allow_all will be able to see all data except data labeled with A and data labeled with B and data with labels A and B.
getName
Required. The unique full name of the data access scope.
The name should comply with https://google.aip.dev/122 standards.
string
setName
Required. The unique full name of the data access scope.
The name should comply with https://google.aip.dev/122 standards.
var
string
$this
getAllowedDataAccessLabels
Optional. The allowed labels for the scope.
Either allow_all or allowed_data_access_labels needs to be provided. When provided, there has to be at least one label allowed for the scope to be valid. The logical operator for evaluation of the allowed labels is OR. E.g.: A customer with scope with allowed labels A and B will be able to see data with labeled with A or B or (A and B).
setAllowedDataAccessLabels
Optional. The allowed labels for the scope.
Either allow_all or allowed_data_access_labels needs to be provided. When provided, there has to be at least one label allowed for the scope to be valid. The logical operator for evaluation of the allowed labels is OR. E.g.: A customer with scope with allowed labels A and B will be able to see data with labeled with A or B or (A and B).
$this
getDeniedDataAccessLabels
Optional. The denied labels for the scope.
The logical operator for evaluation of the denied labels is AND. E.g.: A customer with scope with denied labels A and B won't be able to see data labeled with A and data labeled with B and data with labels A and B.
setDeniedDataAccessLabels
Optional. The denied labels for the scope.
The logical operator for evaluation of the denied labels is AND. E.g.: A customer with scope with denied labels A and B won't be able to see data labeled with A and data labeled with B and data with labels A and B.
$this
getDisplayName
Output only. The name to be used for display to customers of the data access scope.
string
setDisplayName
Output only. The name to be used for display to customers of the data access scope.
var
string
$this
getCreateTime
Output only. The time at which the data access scope was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the data access scope was created.
$this
getUpdateTime
Output only. The time at which the data access scope was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which the data access scope was last updated.
$this
getAuthor
Output only. The user who created the data access scope.
string
setAuthor
Output only. The user who created the data access scope.
var
string
$this
getLastEditor
Output only. The user who last updated the data access scope.
string
setLastEditor
Output only. The user who last updated the data access scope.
var
string
$this
getDescription
Optional. A description of the data access scope for a human reader.
string
setDescription
Optional. A description of the data access scope for a human reader.
var
string
$this
getAllowAll
Optional. Whether or not the scope allows all labels, allow_all and allowed_data_access_labels are mutually exclusive and one of them must be present. denied_data_access_labels can still be used along with allow_all.
When combined with denied_data_access_labels, access will be granted to all data that doesn't have labels mentioned in denied_data_access_labels. E.g.: A customer with scope with denied labels A and B and allow_all will be able to see all data except data labeled with A and data labeled with B and data with labels A and B.
bool
setAllowAll
Optional. Whether or not the scope allows all labels, allow_all and allowed_data_access_labels are mutually exclusive and one of them must be present. denied_data_access_labels can still be used along with allow_all.
When combined with denied_data_access_labels, access will be granted to all data that doesn't have labels mentioned in denied_data_access_labels. E.g.: A customer with scope with denied labels A and B and allow_all will be able to see all data except data labeled with A and data labeled with B and data with labels A and B.
var
bool
$this
