Discovery Engine v1 API - Class Principal (1.8.0) 

public sealed class Principal : IMessage<Principal>, IEquatable<Principal>, IDeepCloneable<Principal>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class Principal.

Principal identifier of a user or a group.

Inheritance

object > Principal

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

Principal()

public Principal()

Principal(Principal)

public Principal(Principal other)
Parameter
Name Description
other Principal

Properties

ExternalEntityId

public string ExternalEntityId { get; set; }

For 3P application identities which are not present in the customer identity provider.

Property Value
Type Description
string

GroupId

public string GroupId { get; set; }

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.

Property Value
Type Description
string

HasExternalEntityId

public bool HasExternalEntityId { get; }

Gets whether the "external_entity_id" field is set

Property Value
Type Description
bool

HasGroupId

public bool HasGroupId { get; }

Gets whether the "group_id" field is set

Property Value
Type Description
bool

HasUserId

public bool HasUserId { get; }

Gets whether the "user_id" field is set

Property Value
Type Description
bool

PrincipalCase

public Principal.PrincipalOneofCase PrincipalCase { get; }
Property Value
Type Description
PrincipalPrincipalOneofCase

UserId

public string UserId { get; set; }

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.

Property Value
Type Description
string