Reference documentation and code samples for the Google Cloud Chronicle V1 Client class DataAccessLabel.
A DataAccessLabel is a label on events to define user access to data.
Generated from protobuf message google.cloud.chronicle.v1.DataAccessLabel
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ udm_query |
string
A UDM query over event data. |
↳ name |
string
The unique resource name of the data access label. |
↳ display_name |
string
Output only. The short name displayed for the label as it appears on event data. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time at which the data access label was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time at which the data access label was last updated. |
↳ author |
string
Output only. The user who created the data access label. |
↳ last_editor |
string
Output only. The user who last updated the data access label. |
↳ description |
string
Optional. A description of the data access label for a human reader. |
getUdmQuery
A UDM query over event data.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasUdmQuery
setUdmQuery
A UDM query over event data.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
The unique resource name of the data access label.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
The unique resource name of the data access label.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Output only. The short name displayed for the label as it appears on event data.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Output only. The short name displayed for the label as it appears on event data.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time at which the data access label was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the data access label was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time at which the data access label was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which the data access label was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAuthor
Output only. The user who created the data access label.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAuthor
Output only. The user who created the data access label.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastEditor
Output only. The user who last updated the data access label.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLastEditor
Output only. The user who last updated the data access label.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A description of the data access label for a human reader.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. A description of the data access label for a human reader.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefinition
| Returns | |
|---|---|
| Type | Description |
string |
|