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

  • Method Details

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

      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 Tagsin the Amazon QuickSight User Guide.

    • 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 (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.

      If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

      Currently, you can pass up to 25 theme 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 (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.

      If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

      Currently, you can pass up to 25 theme ARNs in each API call.

    • experienceConfiguration

      public final AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration()

      The configuration of the experience that you are embedding.

      Returns:
      The configuration of the experience that you are embedding.

    • hasAllowedDomains

      public final boolean hasAllowedDomains()
      For responses, this returns true if the service returned a value for the AllowedDomains 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.

    • allowedDomains

      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.

      Returns:
      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.

    • toBuilder

      public GenerateEmbedUrlForAnonymousUserRequest.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<GenerateEmbedUrlForAnonymousUserRequest.Builder,GenerateEmbedUrlForAnonymousUserRequest>
      Specified by:
      toBuilder in class QuickSightRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.