@Generated(value="software.amazon.awssdk:codegen") public final class GenerateEmbedUrlForAnonymousUserRequest extends QuickSightRequest implements ToCopyableBuilder<GenerateEmbedUrlForAnonymousUserRequest.Builder,GenerateEmbedUrlForAnonymousUserRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GenerateEmbedUrlForAnonymousUserRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
List<String> |
allowedDomains()
The domains that you want to add to the allow list for access to the generated URL that is then embedded.
|
List<String> |
authorizedResourceArns()
The Amazon Resource Names (ARNs) 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 that you are embedding.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAllowedDomains()
For responses, this returns true if the service returned a value for the AllowedDomains property.
|
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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String awsAccountId()
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
public final Long sessionLifetimeInMinutes()
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
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.
default.public final boolean hasSessionTags()
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.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 Tagsin the Amazon QuickSight User Guide.
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.
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 Tagsin the Amazon QuickSight User Guide.
public final boolean hasAuthorizedResourceArns()
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.public final List<String> authorizedResourceArns()
The Amazon Resource Names (ARNs) 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.
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.public final AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration()
The configuration of the experience that you are embedding.
public final boolean hasAllowedDomains()
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.public final List<String> allowedDomains()
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use *. For example,
https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.
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 hasAllowedDomains() method.
To include all subdomains under a specific domain to the allow list, use *. For example,
https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.
public GenerateEmbedUrlForAnonymousUserRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<GenerateEmbedUrlForAnonymousUserRequest.Builder,GenerateEmbedUrlForAnonymousUserRequest>toBuilder in class QuickSightRequestpublic static GenerateEmbedUrlForAnonymousUserRequest.Builder builder()
public static Class<? extends GenerateEmbedUrlForAnonymousUserRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.