com.amazonaws.services.quicksight.model

Class GenerateEmbedUrlForAnonymousUserRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.GenerateEmbedUrlForAnonymousUserRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GenerateEmbedUrlForAnonymousUserRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GenerateEmbedUrlForAnonymousUserRequest()

Method Summary

Modifier and Type	Method and Description
GenerateEmbedUrlForAnonymousUserRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAuthorizedResourceArns() The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session.
String	getAwsAccountId() The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
AnonymousUserEmbeddingExperienceConfiguration	getExperienceConfiguration() The configuration of the experience you are embedding.
String	getNamespace() The Amazon QuickSight namespace that the anonymous user virtually belongs to.
Long	getSessionLifetimeInMinutes() How many minutes the session is valid.
List<SessionTag>	getSessionTags() The session tags used for row-level security.
int	hashCode()
void	setAuthorizedResourceArns(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.
void	setAwsAccountId(String awsAccountId) The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
void	setExperienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration) The configuration of the experience you are embedding.
void	setNamespace(String namespace) The Amazon QuickSight namespace that the anonymous user virtually belongs to.
void	setSessionLifetimeInMinutes(Long sessionLifetimeInMinutes) How many minutes the session is valid.
void	setSessionTags(Collection<SessionTag> sessionTags) The session tags used for row-level security.
String	toString() Returns a string representation of this object.
GenerateEmbedUrlForAnonymousUserRequest	withAuthorizedResourceArns(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	withAuthorizedResourceArns(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	withAwsAccountId(String awsAccountId) The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
GenerateEmbedUrlForAnonymousUserRequest	withExperienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration) The configuration of the experience you are embedding.
GenerateEmbedUrlForAnonymousUserRequest	withNamespace(String namespace) The Amazon QuickSight namespace that the anonymous user virtually belongs to.
GenerateEmbedUrlForAnonymousUserRequest	withSessionLifetimeInMinutes(Long sessionLifetimeInMinutes) How many minutes the session is valid.
GenerateEmbedUrlForAnonymousUserRequest	withSessionTags(Collection<SessionTag> sessionTags) The session tags used for row-level security.
GenerateEmbedUrlForAnonymousUserRequest	withSessionTags(SessionTag... sessionTags) The session tags used for row-level security.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GenerateEmbedUrlForAnonymousUserRequest

public GenerateEmbedUrlForAnonymousUserRequest()

Method Detail

setAwsAccountId

public void setAwsAccountId(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.

getAwsAccountId

public String getAwsAccountId()

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

Returns:

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

withAwsAccountId

public GenerateEmbedUrlForAnonymousUserRequest withAwsAccountId(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.

setSessionLifetimeInMinutes

public void setSessionLifetimeInMinutes(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.

getSessionLifetimeInMinutes

public Long getSessionLifetimeInMinutes()

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

Returns:

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

withSessionLifetimeInMinutes

public GenerateEmbedUrlForAnonymousUserRequest withSessionLifetimeInMinutes(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.

setNamespace

public void setNamespace(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.

getNamespace

public String getNamespace()

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:

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.

withNamespace

public GenerateEmbedUrlForAnonymousUserRequest withNamespace(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.

getSessionTags

public List<SessionTag> getSessionTags()

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:

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.

setSessionTags

public void setSessionTags(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.

withSessionTags

public GenerateEmbedUrlForAnonymousUserRequest withSessionTags(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.

NOTE: This method appends the values to the existing list (if any). Use setSessionTags(java.util.Collection) or withSessionTags(java.util.Collection) if you want to override the existing values.

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.

withSessionTags

public GenerateEmbedUrlForAnonymousUserRequest withSessionTags(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.

getAuthorizedResourceArns

public List<String> getAuthorizedResourceArns()

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:

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.

setAuthorizedResourceArns

public void setAuthorizedResourceArns(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.

withAuthorizedResourceArns

public GenerateEmbedUrlForAnonymousUserRequest withAuthorizedResourceArns(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.

NOTE: This method appends the values to the existing list (if any). Use setAuthorizedResourceArns(java.util.Collection) or withAuthorizedResourceArns(java.util.Collection) if you want to override the existing values.

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.

withAuthorizedResourceArns

public GenerateEmbedUrlForAnonymousUserRequest withAuthorizedResourceArns(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.

setExperienceConfiguration

public void setExperienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration)

The configuration of the experience you are embedding.

Parameters:

experienceConfiguration - The configuration of the experience you are embedding.

getExperienceConfiguration

public AnonymousUserEmbeddingExperienceConfiguration getExperienceConfiguration()

The configuration of the experience you are embedding.

Returns:

The configuration of the experience you are embedding.

withExperienceConfiguration

public GenerateEmbedUrlForAnonymousUserRequest withExperienceConfiguration(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GenerateEmbedUrlForAnonymousUserRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()