Class: Google::Cloud::DiscoveryEngine::V1::Principal

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::Principal

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1/common.rb

Overview

Principal identifier of a user or a group.

Instance Attribute Summary

• #external_entity_id ⇒ ::String

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

• #group_id ⇒ ::String

  Group identifier.

• #user_id ⇒ ::String

  User identifier.

Instance Attribute Details

#external_entity_id ⇒ ::String

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1/common.rb', line 149

class Principal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#group_id ⇒ ::String

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1/common.rb', line 149

class Principal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#user_id ⇒ ::String

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1/common.rb', line 149

class Principal
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end