Class: Aws::QBusiness::Types::Principal

Inherits:
Struct
  • Object
show all
Includes:
Structure, Structure::Union
Defined in:
lib/aws-sdk-qbusiness/types.rb

Overview

Note:

Principal is a union - when making an API calls you must set exactly one of the members.

Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.

See Also:

Direct Known Subclasses

Group, Unknown, User

Defined Under Namespace

Classes: Group, Unknown, User

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#group ⇒ Types::PrincipalGroup

The group associated with the principal.

Returns:



6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6153

class Principal < Struct.new(
  :user,
  :group,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class User < Principal; end
  class Group < Principal; end
  class Unknown < Principal; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



6153
6154
6155
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6153

def unknown
  @unknown
end

#user ⇒ Types::PrincipalUser

The user associated with the principal.

Returns:



6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6153

class Principal < Struct.new(
  :user,
  :group,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class User < Principal; end
  class Group < Principal; end
  class Unknown < Principal; end
end