com.amazonaws.services.quicksight.model

Class GenerateEmbedUrlForRegisteredUserRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.GenerateEmbedUrlForRegisteredUserRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GenerateEmbedUrlForRegisteredUserRequest
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
GenerateEmbedUrlForRegisteredUserRequest()

Method Summary

Modifier and Type	Method and Description
GenerateEmbedUrlForRegisteredUserRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAllowedDomains() The domains that you want to add to the allow list for access to the generated URL that is then embedded.
String	getAwsAccountId() The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
RegisteredUserEmbeddingExperienceConfiguration	getExperienceConfiguration() The experience that you want to embed.
Long	getSessionLifetimeInMinutes() How many minutes the session is valid.
String	getUserArn() The Amazon Resource Name for the registered user.
int	hashCode()
void	setAllowedDomains(Collection<String> allowedDomains) The domains that you want to add to the allow list for access to the generated URL that is then embedded.
void	setAwsAccountId(String awsAccountId) The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
void	setExperienceConfiguration(RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration) The experience that you want to embed.
void	setSessionLifetimeInMinutes(Long sessionLifetimeInMinutes) How many minutes the session is valid.
void	setUserArn(String userArn) The Amazon Resource Name for the registered user.
String	toString() Returns a string representation of this object.
GenerateEmbedUrlForRegisteredUserRequest	withAllowedDomains(Collection<String> allowedDomains) The domains that you want to add to the allow list for access to the generated URL that is then embedded.
GenerateEmbedUrlForRegisteredUserRequest	withAllowedDomains(String... allowedDomains) The domains that you want to add to the allow list for access to the generated URL that is then embedded.
GenerateEmbedUrlForRegisteredUserRequest	withAwsAccountId(String awsAccountId) The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
GenerateEmbedUrlForRegisteredUserRequest	withExperienceConfiguration(RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration) The experience that you want to embed.
GenerateEmbedUrlForRegisteredUserRequest	withSessionLifetimeInMinutes(Long sessionLifetimeInMinutes) How many minutes the session is valid.
GenerateEmbedUrlForRegisteredUserRequest	withUserArn(String userArn) The Amazon Resource Name for the registered user.

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

GenerateEmbedUrlForRegisteredUserRequest

public GenerateEmbedUrlForRegisteredUserRequest()

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

setUserArn

public void setUserArn(String userArn)

The Amazon Resource Name for the registered user.

Parameters:

userArn - The Amazon Resource Name for the registered user.

getUserArn

public String getUserArn()

The Amazon Resource Name for the registered user.

Returns:

The Amazon Resource Name for the registered user.

withUserArn

public GenerateEmbedUrlForRegisteredUserRequest withUserArn(String userArn)

The Amazon Resource Name for the registered user.

Parameters:

userArn - The Amazon Resource Name for the registered user.

Returns:

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

setExperienceConfiguration

public void setExperienceConfiguration(RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration)

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

Parameters:

experienceConfiguration - The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

getExperienceConfiguration

public RegisteredUserEmbeddingExperienceConfiguration getExperienceConfiguration()

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

Returns:

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

withExperienceConfiguration

public GenerateEmbedUrlForRegisteredUserRequest withExperienceConfiguration(RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration)

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

Parameters:

experienceConfiguration - The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

Returns:

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

getAllowedDomains

public List<String> getAllowedDomains()

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

Returns:

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

setAllowedDomains

public void setAllowedDomains(Collection<String> allowedDomains)

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

Parameters:

allowedDomains - The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

withAllowedDomains

public GenerateEmbedUrlForRegisteredUserRequest withAllowedDomains(String... allowedDomains)

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

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

Parameters:

allowedDomains - The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

Returns:

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

withAllowedDomains

public GenerateEmbedUrlForRegisteredUserRequest withAllowedDomains(Collection<String> allowedDomains)

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

Parameters:

allowedDomains - The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

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 GenerateEmbedUrlForRegisteredUserRequest 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()