software.amazon.awssdk.services.quicksight.model

Class GetDashboardEmbedUrlResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.quicksight.model.QuickSightResponse

software.amazon.awssdk.services.quicksight.model.GetDashboardEmbedUrlResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDashboardEmbedUrlResponse.Builder,GetDashboardEmbedUrlResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetDashboardEmbedUrlResponse
extends QuickSightResponse
implements ToCopyableBuilder<GetDashboardEmbedUrlResponse.Builder,GetDashboardEmbedUrlResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDashboardEmbedUrlResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetDashboardEmbedUrlResponse.Builder	builder()
String	embedUrl() Call the GetDashboardEmbedUrl API to get the URL that you can embed in your dashboard.
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 SdkResponse.
int	hashCode()
String	requestId() The AWS request ID for this operation.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDashboardEmbedUrlResponse.Builder>	serializableBuilderClass()
Integer	status() The http status of the request.
GetDashboardEmbedUrlResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.services.quicksight.model.QuickSightResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

embedUrl

public String embedUrl()

Call the GetDashboardEmbedUrl API to get the URL that you can embed in your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code that enables a single-signon session.

Returns:

Call the GetDashboardEmbedUrl API to get the URL that you can embed in your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code that enables a single-signon session.

status

public Integer status()

The http status of the request.

Returns:

The http status of the request.

requestId

public String requestId()

The AWS request ID for this operation.

Returns:

The AWS request ID for this operation.

toBuilder

public GetDashboardEmbedUrlResponse.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<GetDashboardEmbedUrlResponse.Builder,GetDashboardEmbedUrlResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetDashboardEmbedUrlResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetDashboardEmbedUrlResponse.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: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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.