Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DataProductAccessRequest.
Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS.
Generated from protobuf message google.cloud.dataplex.v1.DataProductAccessRequest
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id} |
↳ access_group_id |
string
Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product. |
↳ access_group_display_name |
string
Output only. The display name of the access group defined in the Data Product for which access is being requested. |
↳ requested_principal |
string
Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: |
getParent
Required. The resource name of the data product.
Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The resource name of the data product.
Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccessGroupId
Required. The ID of the access group for which access is being requested.
This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAccessGroupId
Required. The ID of the access group for which access is being requested.
This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccessGroupDisplayName
Output only. The display name of the access group defined in the Data Product for which access is being requested.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAccessGroupDisplayName
Output only. The display name of the access group defined in the Data Product for which access is being requested.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestedPrincipal
Optional. The principal for which access is being requested in IAM format.
If not specified, the requestor's principal will be used.
Example: serviceAccount:my-sa\@my-project.iam.gserviceaccount.com.
Only service account principals are currently supported.
https://cloud.google.com/iam/docs/principal-identifiers
| Returns | |
|---|---|
| Type | Description |
string |
|
hasRequestedPrincipal
clearRequestedPrincipal
setRequestedPrincipal
Optional. The principal for which access is being requested in IAM format.
If not specified, the requestor's principal will be used.
Example: serviceAccount:my-sa\@my-project.iam.gserviceaccount.com.
Only service account principals are currently supported.
https://cloud.google.com/iam/docs/principal-identifiers
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|