Google Cloud Chronicle V1 Client - Class DataAccessScope (0.1.2)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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 Google\Protobuf\Timestamp

Output only. The time at which the data access scope was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The time at which the data access scope was last updated.
↳ 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.

Returns
Type Description
string

setName

Required. The unique full name of the data access scope.

The name should comply with https://google.aip.dev/122 standards.

Parameter
Name Description
var string
Returns
Type Description
$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).

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

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).

Parameter
Name Description
var array<DataAccessLabelReference>
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

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.

Parameter
Name Description
var array<DataAccessLabelReference>
Returns
Type Description
$this

getDisplayName

Output only. The name to be used for display to customers of the data access scope.

Returns
Type Description
string

setDisplayName

Output only. The name to be used for display to customers of the data access scope.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The time at which the data access scope was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which the data access scope was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The time at which the data access scope was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time at which the data access scope was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getAuthor

Output only. The user who created the data access scope.

Returns
Type Description
string

setAuthor

Output only. The user who created the data access scope.

Parameter
Name Description
var string
Returns
Type Description
$this

getLastEditor

Output only. The user who last updated the data access scope.

Returns
Type Description
string

setLastEditor

Output only. The user who last updated the data access scope.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. A description of the data access scope for a human reader.

Returns
Type Description
string

setDescription

Optional. A description of the data access scope for a human reader.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$this