software.amazon.awssdk.services.quicksight.model

Interface GenerateEmbedUrlForAnonymousUserRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GenerateEmbedUrlForAnonymousUserRequest.Builder,GenerateEmbedUrlForAnonymousUserRequest>, QuickSightRequest.Builder, SdkBuilder<GenerateEmbedUrlForAnonymousUserRequest.Builder,GenerateEmbedUrlForAnonymousUserRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GenerateEmbedUrlForAnonymousUserRequest

public static interface GenerateEmbedUrlForAnonymousUserRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<GenerateEmbedUrlForAnonymousUserRequest.Builder,GenerateEmbedUrlForAnonymousUserRequest>

Method Summary

Modifier and Type	Method and Description
GenerateEmbedUrlForAnonymousUserRequest.Builder	authorizedResourceArns(Collection<String> authorizedResourceArns) The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session.
GenerateEmbedUrlForAnonymousUserRequest.Builder	authorizedResourceArns(String... authorizedResourceArns) The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session.
GenerateEmbedUrlForAnonymousUserRequest.Builder	awsAccountId(String awsAccountId) The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
GenerateEmbedUrlForAnonymousUserRequest.Builder	experienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration) The configuration of the experience you are embedding.
default GenerateEmbedUrlForAnonymousUserRequest.Builder	experienceConfiguration(Consumer<AnonymousUserEmbeddingExperienceConfiguration.Builder> experienceConfiguration) The configuration of the experience you are embedding.
GenerateEmbedUrlForAnonymousUserRequest.Builder	namespace(String namespace) The Amazon QuickSight namespace that the anonymous user virtually belongs to.
GenerateEmbedUrlForAnonymousUserRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GenerateEmbedUrlForAnonymousUserRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GenerateEmbedUrlForAnonymousUserRequest.Builder	sessionLifetimeInMinutes(Long sessionLifetimeInMinutes) How many minutes the session is valid.
GenerateEmbedUrlForAnonymousUserRequest.Builder	sessionTags(Collection<SessionTag> sessionTags) The session tags used for row-level security.
GenerateEmbedUrlForAnonymousUserRequest.Builder	sessionTags(Consumer<SessionTag.Builder>... sessionTags) The session tags used for row-level security.
GenerateEmbedUrlForAnonymousUserRequest.Builder	sessionTags(SessionTag... sessionTags) The session tags used for row-level security.

Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

awsAccountId

GenerateEmbedUrlForAnonymousUserRequest.Builder awsAccountId(String awsAccountId)

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

Parameters:

awsAccountId - The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

Returns:

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

sessionLifetimeInMinutes

GenerateEmbedUrlForAnonymousUserRequest.Builder sessionLifetimeInMinutes(Long sessionLifetimeInMinutes)

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

Parameters:

sessionLifetimeInMinutes - How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

Returns:

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

namespace

GenerateEmbedUrlForAnonymousUserRequest.Builder namespace(String namespace)

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

Parameters:

namespace - The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

Returns:

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

sessionTags

GenerateEmbedUrlForAnonymousUserRequest.Builder sessionTags(Collection<SessionTag> sessionTags)

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags.

Parameters:

sessionTags - The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags.

Returns:

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

sessionTags

GenerateEmbedUrlForAnonymousUserRequest.Builder sessionTags(SessionTag... sessionTags)

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags.

Parameters:

sessionTags - The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags.

Returns:

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

sessionTags

GenerateEmbedUrlForAnonymousUserRequest.Builder sessionTags(Consumer<SessionTag.Builder>... sessionTags)

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags.

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #sessionTags(List).

Parameters:

sessionTags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#sessionTags(List)

authorizedResourceArns

GenerateEmbedUrlForAnonymousUserRequest.Builder authorizedResourceArns(Collection<String> authorizedResourceArns)

The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.

Parameters:

authorizedResourceArns - The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.

Returns:

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

authorizedResourceArns

GenerateEmbedUrlForAnonymousUserRequest.Builder authorizedResourceArns(String... authorizedResourceArns)

The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.

Parameters:

authorizedResourceArns - The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.

Returns:

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

experienceConfiguration

GenerateEmbedUrlForAnonymousUserRequest.Builder experienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration)

The configuration of the experience you are embedding.

Parameters:

experienceConfiguration - The configuration of the experience you are embedding.

Returns:

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

experienceConfiguration

default GenerateEmbedUrlForAnonymousUserRequest.Builder experienceConfiguration(Consumer<AnonymousUserEmbeddingExperienceConfiguration.Builder> experienceConfiguration)

The configuration of the experience you are embedding.

This is a convenience method that creates an instance of the AnonymousUserEmbeddingExperienceConfiguration.Builder avoiding the need to create one manually via AnonymousUserEmbeddingExperienceConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to experienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration).

Parameters:

experienceConfiguration - a consumer that will call methods on AnonymousUserEmbeddingExperienceConfiguration.Builder

Returns:

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

See Also:

experienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration)

overrideConfiguration

GenerateEmbedUrlForAnonymousUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GenerateEmbedUrlForAnonymousUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder