software.amazon.awssdk.services.quicksight.model

Class GenerateEmbedUrlForAnonymousUserRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GenerateEmbedUrlForAnonymousUserRequest.Builder,GenerateEmbedUrlForAnonymousUserRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GenerateEmbedUrlForAnonymousUserRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	authorizedResourceArns() The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session.
String	awsAccountId() The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
static GenerateEmbedUrlForAnonymousUserRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
AnonymousUserEmbeddingExperienceConfiguration	experienceConfiguration() The configuration of the experience you are embedding.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAuthorizedResourceArns() For responses, this returns true if the service returned a value for the AuthorizedResourceArns property.
int	hashCode()
boolean	hasSessionTags() For responses, this returns true if the service returned a value for the SessionTags property.
String	namespace() The Amazon QuickSight namespace that the anonymous user virtually belongs to.
List<SdkField<?>>	sdkFields()
static Class<? extends GenerateEmbedUrlForAnonymousUserRequest.Builder>	serializableBuilderClass()
Long	sessionLifetimeInMinutes() How many minutes the session is valid.
List<SessionTag>	sessionTags() The session tags used for row-level security.
GenerateEmbedUrlForAnonymousUserRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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.

namespace

public final String namespace()

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

Returns:

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

hasSessionTags

public final boolean hasSessionTags()

For responses, this returns true if the service returned a value for the SessionTags 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.

sessionTags

public final List<SessionTag> sessionTags()

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags.

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 hasSessionTags() method.

Returns:

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags.

hasAuthorizedResourceArns

public final boolean hasAuthorizedResourceArns()

For responses, this returns true if the service returned a value for the AuthorizedResourceArns 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.

authorizedResourceArns

public final List<String> authorizedResourceArns()

The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25 dashboard ARNs in each API call.

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 hasAuthorizedResourceArns() method.

Returns:

The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25 dashboard ARNs in each API call.

experienceConfiguration

public final AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration()

The configuration of the experience you are embedding.

Returns:

The configuration of the experience you are embedding.

toBuilder

public GenerateEmbedUrlForAnonymousUserRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GenerateEmbedUrlForAnonymousUserRequest.Builder,GenerateEmbedUrlForAnonymousUserRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static GenerateEmbedUrlForAnonymousUserRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GenerateEmbedUrlForAnonymousUserRequest.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