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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetDashboardEmbedUrlRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`additionalDashboardIds()`	A list of one or more dashboard IDs that you want anonymous users to have tempporary access to.
`String`	`awsAccountId()`	The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
`static GetDashboardEmbedUrlRequest.Builder`	`builder()`
`String`	`dashboardId()`	The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalDashboardIds()`	For responses, this returns true if the service returned a value for the AdditionalDashboardIds property.
`int`	`hashCode()`
`EmbeddingIdentityType`	`identityType()`	The authentication method that the user uses to sign in.
`String`	`identityTypeAsString()`	The authentication method that the user uses to sign in.
`String`	`namespace()`	The Amazon QuickSight namespace that contains the dashboard IDs in this request.
`Boolean`	`resetDisabled()`	Remove the reset button on the embedded dashboard.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetDashboardEmbedUrlRequest.Builder>`	`serializableBuilderClass()`
`Long`	`sessionLifetimeInMinutes()`	How many minutes the session is valid.
`Boolean`	`statePersistenceEnabled()`	Adds persistence of state for the user session in an embedded dashboard.
`GetDashboardEmbedUrlRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Boolean`	`undoRedoDisabled()`	Remove the undo/redo button on the embedded dashboard.
`String`	`userArn()`	The Amazon QuickSight user's Amazon Resource Name (ARN), for use with `QUICKSIGHT` identity type.

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.
  - dashboardId
```
public final String dashboardId()
```
    The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
    
    Returns:
    
    The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
  - identityType
```
public final EmbeddingIdentityType identityType()
```
    The authentication method that the user uses to sign in.
    
    If the service returns an enum value that is not available in the current SDK version, identityType will return EmbeddingIdentityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityTypeAsString().
    
    Returns:
    
    The authentication method that the user uses to sign in.
    
    See Also:
    
    EmbeddingIdentityType
  - identityTypeAsString
```
public final String identityTypeAsString()
```
    The authentication method that the user uses to sign in.
    
    If the service returns an enum value that is not available in the current SDK version, identityType will return EmbeddingIdentityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityTypeAsString().
    
    Returns:
    
    The authentication method that the user uses to sign in.
    
    See Also:
    
    EmbeddingIdentityType
  - sessionLifetimeInMinutes
```
public final Long sessionLifetimeInMinutes()
```
    How many minutes the session is valid. The session lifetime must be 15-600 minutes.
    
    Returns:
    
    How many minutes the session is valid. The session lifetime must be 15-600 minutes.
  - undoRedoDisabled
```
public final Boolean undoRedoDisabled()
```
    Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
    
    Returns:
    
    Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
  - resetDisabled
```
public final Boolean resetDisabled()
```
    Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
    
    Returns:
    
    Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
  - statePersistenceEnabled
```
public final Boolean statePersistenceEnabled()
```
    Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.
    
    Returns:
    
    Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.
  - userArn
```
public final String userArn()
```
    The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:
    
    Active Directory (AD) users or group members
    
    Invited nonfederated users
    
    IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.
    
    Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
    Returns:
    
    The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:
    
    Active Directory (AD) users or group members
    
    Invited nonfederated users
    
    IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.
    
    Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
  - namespace
```
public final String namespace()
```
    The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default.
    
    Returns:
    
    The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default.
  - hasAdditionalDashboardIds
```
public final boolean hasAdditionalDashboardIds()
```
    For responses, this returns true if the service returned a value for the AdditionalDashboardIds 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.
  - additionalDashboardIds
```
public final List<String> additionalDashboardIds()
```
    A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.
    
    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 hasAdditionalDashboardIds() method.
    
    Returns:
    
    A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.
  - toBuilder
```
public GetDashboardEmbedUrlRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetDashboardEmbedUrlRequest.Builder,GetDashboardEmbedUrlRequest>
    
    Specified by:
    
    toBuilder in class QuickSightRequest
  - builder
```
public static GetDashboardEmbedUrlRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetDashboardEmbedUrlRequest.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 GetDashboardEmbedUrlRequest

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

dashboardId

identityType

identityTypeAsString

sessionLifetimeInMinutes

undoRedoDisabled

resetDisabled

statePersistenceEnabled

userArn

namespace

hasAdditionalDashboardIds

additionalDashboardIds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields