Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::Principal (v2.4.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::Principal.

Principal identifier of a user or a group.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#external_entity_id

def external_entity_id() -> ::String
Returns
  • (::String) — For 3P application identities which are not present in the customer identity provider.

    Note: The following fields are mutually exclusive: external_entity_id, user_id, group_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

#external_entity_id=

def external_entity_id=(value) -> ::String
Parameter
  • value (::String) — For 3P application identities which are not present in the customer identity provider.

    Note: The following fields are mutually exclusive: external_entity_id, user_id, group_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — For 3P application identities which are not present in the customer identity provider.

    Note: The following fields are mutually exclusive: external_entity_id, user_id, group_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

#group_id

def group_id() -> ::String
Returns
  • (::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.

    Note: The following fields are mutually exclusive: group_id, user_id, external_entity_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

#group_id=

def group_id=(value) -> ::String
Parameter
  • value (::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.

    Note: The following fields are mutually exclusive: group_id, user_id, external_entity_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::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.

    Note: The following fields are mutually exclusive: group_id, user_id, external_entity_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

#user_id

def user_id() -> ::String
Returns
  • (::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.

    Note: The following fields are mutually exclusive: user_id, group_id, external_entity_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

#user_id=

def user_id=(value) -> ::String
Parameter
  • value (::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.

    Note: The following fields are mutually exclusive: user_id, group_id, external_entity_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::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.

    Note: The following fields are mutually exclusive: user_id, group_id, external_entity_id. If a field in that set is populated, all other fields in the set will automatically be cleared.