Class RegisteredUserDashboardEmbeddingConfiguration

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

Information about the dashboard 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 Quick Sight renders this dashboard if the user has permissions to view it.

      If the user does not have permission to view this dashboard, they see a permissions error message.

      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 Quick Sight renders this dashboard if the user has permissions to view it.

      If the user does not have permission to view this dashboard, they see a permissions error message.

    • featureConfigurations

      public final RegisteredUserDashboardFeatureConfigurations featureConfigurations()

      The feature configurations of an embbedded Amazon Quick Sight dashboard.

      Returns:
      The feature configurations of an embbedded Amazon Quick Sight dashboard.

    • toBuilder

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

    • builder

      public static RegisteredUserDashboardEmbeddingConfiguration.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.