software.amazon.awssdk.services.kendra.model

Interface UserContext.Builder

All Superinterfaces:

Buildable, CopyableBuilder<UserContext.Builder,UserContext>, SdkBuilder<UserContext.Builder,UserContext>, SdkPojo

Enclosing class:

UserContext

public static interface UserContext.Builder
extends SdkPojo, CopyableBuilder<UserContext.Builder,UserContext>

Method Summary

Modifier and Type	Method and Description
UserContext.Builder	dataSourceGroups(Collection<DataSourceGroup> dataSourceGroups) The list of data source groups you want to filter search results based on groups' access to documents in that data source.
UserContext.Builder	dataSourceGroups(Consumer<DataSourceGroup.Builder>... dataSourceGroups) The list of data source groups you want to filter search results based on groups' access to documents in that data source.
UserContext.Builder	dataSourceGroups(DataSourceGroup... dataSourceGroups) The list of data source groups you want to filter search results based on groups' access to documents in that data source.
UserContext.Builder	groups(Collection<String> groups) The list of groups you want to filter search results based on the groups' access to documents.
UserContext.Builder	groups(String... groups) The list of groups you want to filter search results based on the groups' access to documents.
UserContext.Builder	token(String token) The user context token for filtering search results for a user.
UserContext.Builder	userId(String userId) The identifier of the user you want to filter search results based on their access to documents.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

token

UserContext.Builder token(String token)

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

Parameters:

token - The user context token for filtering search results for a user. It must be a JWT or a JSON token.

Returns:

Returns a reference to this object so that method calls can be chained together.

userId

UserContext.Builder userId(String userId)

The identifier of the user you want to filter search results based on their access to documents.

Parameters:

userId - The identifier of the user you want to filter search results based on their access to documents.

Returns:

Returns a reference to this object so that method calls can be chained together.

groups

UserContext.Builder groups(Collection<String> groups)

The list of groups you want to filter search results based on the groups' access to documents.

Parameters:

groups - The list of groups you want to filter search results based on the groups' access to documents.

Returns:

Returns a reference to this object so that method calls can be chained together.

groups

UserContext.Builder groups(String... groups)

The list of groups you want to filter search results based on the groups' access to documents.

Parameters:

groups - The list of groups you want to filter search results based on the groups' access to documents.

Returns:

Returns a reference to this object so that method calls can be chained together.

dataSourceGroups

UserContext.Builder dataSourceGroups(Collection<DataSourceGroup> dataSourceGroups)

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

Parameters:

dataSourceGroups - The list of data source groups you want to filter search results based on groups' access to documents in that data source.

Returns:

Returns a reference to this object so that method calls can be chained together.

dataSourceGroups

UserContext.Builder dataSourceGroups(DataSourceGroup... dataSourceGroups)

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

Parameters:

dataSourceGroups - The list of data source groups you want to filter search results based on groups' access to documents in that data source.

Returns:

Returns a reference to this object so that method calls can be chained together.

dataSourceGroups

UserContext.Builder dataSourceGroups(Consumer<DataSourceGroup.Builder>... dataSourceGroups)

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

This is a convenience method that creates an instance of the DataSourceGroup.Builder avoiding the need to create one manually via DataSourceGroup.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #dataSourceGroups(List).

Parameters:

dataSourceGroups - a consumer that will call methods on DataSourceGroup.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#dataSourceGroups(java.util.Collection)