Class AnonymousUserDashboardEmbeddingConfiguration

java.lang.Object
software.amazon.awssdk.services.quicksight.model.AnonymousUserDashboardEmbeddingConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AnonymousUserDashboardEmbeddingConfiguration.Builder,AnonymousUserDashboardEmbeddingConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class AnonymousUserDashboardEmbeddingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AnonymousUserDashboardEmbeddingConfiguration.Builder,AnonymousUserDashboardEmbeddingConfiguration>

Information about the dashboard that you want to embed.

See Also:

  • Method Details

    • initialDashboardId

      public final String initialDashboardId()

      The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.

      The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

      Returns:
      The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.

      The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

    • enabledFeatures

      public final List<AnonymousUserDashboardEmbeddingConfigurationEnabledFeature> enabledFeatures()

      A list of all enabled features of a specified anonymous dashboard.

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

      Returns:
      A list of all enabled features of a specified anonymous dashboard.

    • hasEnabledFeatures

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

    • enabledFeaturesAsStrings

      public final List<String> enabledFeaturesAsStrings()

      A list of all enabled features of a specified anonymous dashboard.

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

      Returns:
      A list of all enabled features of a specified anonymous dashboard.

    • disabledFeatures

      public final List<AnonymousUserDashboardEmbeddingConfigurationDisabledFeature> disabledFeatures()

      A list of all disabled features of a specified anonymous dashboard.

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

      Returns:
      A list of all disabled features of a specified anonymous dashboard.

    • hasDisabledFeatures

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

    • disabledFeaturesAsStrings

      public final List<String> disabledFeaturesAsStrings()

      A list of all disabled features of a specified anonymous dashboard.

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

      Returns:
      A list of all disabled features of a specified anonymous dashboard.

    • featureConfigurations

      public final AnonymousUserDashboardFeatureConfigurations featureConfigurations()

      The feature configuration for an embedded dashboard.

      Returns:
      The feature configuration for an embedded dashboard.

    • toBuilder

      public AnonymousUserDashboardEmbeddingConfiguration.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<AnonymousUserDashboardEmbeddingConfiguration.Builder,AnonymousUserDashboardEmbeddingConfiguration>
      Returns:
      a builder for type T

    • builder

      public static AnonymousUserDashboardEmbeddingConfiguration.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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