java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.quicksight.model.QuickSightRequest
    - - software.amazon.awssdk.services.quicksight.model.GenerateEmbedUrlForRegisteredUserRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GenerateEmbedUrlForRegisteredUserRequest.Builder,GenerateEmbedUrlForRegisteredUserRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GenerateEmbedUrlForRegisteredUserRequest
extends QuickSightRequest
implements ToCopyableBuilder<GenerateEmbedUrlForRegisteredUserRequest.Builder,GenerateEmbedUrlForRegisteredUserRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GenerateEmbedUrlForRegisteredUserRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`allowedDomains()`	The domains that you want to add to the allow list for access to the generated URL that is then embedded.
`String`	`awsAccountId()`	The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
`static GenerateEmbedUrlForRegisteredUserRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`RegisteredUserEmbeddingExperienceConfiguration`	`experienceConfiguration()`	The experience that you want to embed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAllowedDomains()`	For responses, this returns true if the service returned a value for the AllowedDomains property.
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GenerateEmbedUrlForRegisteredUserRequest.Builder>`	`serializableBuilderClass()`
`Long`	`sessionLifetimeInMinutes()`	How many minutes the session is valid.
`GenerateEmbedUrlForRegisteredUserRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userArn()`	The Amazon Resource Name for the registered user.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - awsAccountId
```
public final String awsAccountId()
```
    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.
  - sessionLifetimeInMinutes
```
public final Long sessionLifetimeInMinutes()
```
    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.
  - userArn
```
public final String userArn()
```
    The Amazon Resource Name for the registered user.
    
    Returns:
    
    The Amazon Resource Name for the registered user.
  - experienceConfiguration
```
public final 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.
    
    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.
  - hasAllowedDomains
```
public final boolean hasAllowedDomains()
```
    For responses, this returns true if the service returned a value for the AllowedDomains property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - allowedDomains
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowedDomains() method.
    
    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.
  - toBuilder
```
public GenerateEmbedUrlForRegisteredUserRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GenerateEmbedUrlForRegisteredUserRequest.Builder,GenerateEmbedUrlForRegisteredUserRequest>
    
    Specified by:
    
    toBuilder in class QuickSightRequest
  - builder
```
public static GenerateEmbedUrlForRegisteredUserRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GenerateEmbedUrlForRegisteredUserRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GenerateEmbedUrlForRegisteredUserRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

awsAccountId

sessionLifetimeInMinutes

userArn

experienceConfiguration

hasAllowedDomains

allowedDomains

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields