Reference documentation and code samples for the Google Cloud Dataplex V1 Client class AccessGroup.
Custom user defined access groups at the data product level. These are used for granting different levels of access (IAM roles) on the individual data product's data assets.
Generated from protobuf message google.cloud.dataplex.v1.DataProduct.AccessGroup
Namespace
Google \ Cloud \ Dataplex \ V1 \ DataProductMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ id |
string
Required. Unique identifier of the access group within the data product. User defined. Eg. "analyst", "developer", etc. |
↳ display_name |
string
Required. User friendly display name of the access group. Eg. "Analyst", "Developer", etc. |
↳ description |
string
Optional. Description of the access group. |
↳ principal |
Principal
Required. The principal entity associated with this access group. |
getId
Required. Unique identifier of the access group within the data product.
User defined. Eg. "analyst", "developer", etc.
| Returns | |
|---|---|
| Type | Description |
string |
|
setId
Required. Unique identifier of the access group within the data product.
User defined. Eg. "analyst", "developer", etc.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. User friendly display name of the access group.
Eg. "Analyst", "Developer", etc.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Required. User friendly display name of the access group.
Eg. "Analyst", "Developer", etc.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description of the access group.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description of the access group.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrincipal
Required. The principal entity associated with this access group.
| Returns | |
|---|---|
| Type | Description |
Principal|null |
|
hasPrincipal
clearPrincipal
setPrincipal
Required. The principal entity associated with this access group.
| Parameter | |
|---|---|
| Name | Description |
var |
Principal
|
| Returns | |
|---|---|
| Type | Description |
$this |
|