software.amazon.awssdk.services.quicksight.model

Class GetDashboardEmbedUrlRequest

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(value="software.amazon.awssdk:codegen")
public final class GetDashboardEmbedUrlRequest
extends QuickSightRequest
implements ToCopyableBuilder<GetDashboardEmbedUrlRequest.Builder,GetDashboardEmbedUrlRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDashboardEmbedUrlRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	awsAccountId() AWS account ID that contains the dashboard you are embedding.
static GetDashboardEmbedUrlRequest.Builder	builder()
String	dashboardId() The ID for the dashboard, also added to IAM policy
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IdentityType	identityType() The authentication method the user uses to sign in (IAM only).
String	identityTypeAsString() The authentication method the user uses to sign in (IAM only).
Boolean	resetDisabled() Remove the reset button on embedded dashboard.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDashboardEmbedUrlRequest.Builder>	serializableBuilderClass()
Long	sessionLifetimeInMinutes() How many minutes the session is valid.
GetDashboardEmbedUrlRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	undoRedoDisabled() Remove the undo/redo button on embedded dashboard.
String	userArn() The Amazon QuickSight user's 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 String awsAccountId()

AWS account ID that contains the dashboard you are embedding.

Returns:

AWS account ID that contains the dashboard you are embedding.

dashboardId

public String dashboardId()

The ID for the dashboard, also added to IAM policy

Returns:

The ID for the dashboard, also added to IAM policy

identityType

public IdentityType identityType()

The authentication method the user uses to sign in (IAM only).

If the service returns an enum value that is not available in the current SDK version, identityType will return IdentityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityTypeAsString().

Returns:

The authentication method the user uses to sign in (IAM only).

See Also:

IdentityType

identityTypeAsString

public String identityTypeAsString()

The authentication method the user uses to sign in (IAM only).

If the service returns an enum value that is not available in the current SDK version, identityType will return IdentityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityTypeAsString().

Returns:

The authentication method the user uses to sign in (IAM only).

See Also:

IdentityType

sessionLifetimeInMinutes

public Long sessionLifetimeInMinutes()

How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.

Returns:

How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.

undoRedoDisabled

public Boolean undoRedoDisabled()

Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.

Returns:

Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.

resetDisabled

public Boolean resetDisabled()

Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.

Returns:

Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.

userArn

public String userArn()

The Amazon QuickSight user's ARN, for use with QUICKSIGHT identity type. You can use this for any of the following:

• Amazon QuickSight users in your account (readers, authors, or admins)

• AD users

• Invited non-federated users

• Federated IAM users

• Federated IAM role-based sessions

Returns:

The Amazon QuickSight user's ARN, for use with QUICKSIGHT identity type. You can use this for any of the following:

• Amazon QuickSight users in your account (readers, authors, or admins)

• AD users

• Invited non-federated users

• Federated IAM users

• Federated IAM role-based sessions

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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo