Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Principal.
Principal identifier of a user or a group.
Generated from protobuf message google.cloud.discoveryengine.v1.Principal
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ user_id |
string
User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. |
↳ group_id |
string
Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. |
↳ external_entity_id |
string
For 3P application identities which are not present in the customer identity provider. |
getUserId
User identifier.
For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasUserId
setUserId
User identifier.
For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGroupId
Group identifier.
For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasGroupId
setGroupId
Group identifier.
For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExternalEntityId
For 3P application identities which are not present in the customer identity provider.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasExternalEntityId
setExternalEntityId
For 3P application identities which are not present in the customer identity provider.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrincipal
| Returns | |
|---|---|
| Type | Description |
string |
|