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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
IdentityType	identityType() The authentication method the user uses to sign in (IAM or QUICKSIGHT).
String	identityTypeAsString() The authentication method the user uses to sign in (IAM or QUICKSIGHT).
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Boolean	undoRedoDisabled() Remove the undo/redo button on embedded dashboard.

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

overrideConfiguration

Methods inherited from class java.lang.Object

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 or QUICKSIGHT).

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 or QUICKSIGHT).

See Also:

IdentityType

identityTypeAsString

public String identityTypeAsString()

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

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 or QUICKSIGHT).

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.

toBuilder

public GetDashboardEmbedUrlRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetDashboardEmbedUrlRequest.Builder,GetDashboardEmbedUrlRequest>

Specified by:

toBuilder in class QuickSightRequest

Returns:

a builder for type T

builder

public static GetDashboardEmbedUrlRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetDashboardEmbedUrlRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.