Class RegisteredUserQSearchBarEmbeddingConfiguration

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

Information about the Q search bar embedding experience.

See Also:

  • Method Details

    • initialTopicId

      public final String initialTopicId()

      The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Quick Sight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics.

      If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.

      Returns:
      The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Quick Sight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics.

      If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.

    • toBuilder

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

    • builder

      public static RegisteredUserQSearchBarEmbeddingConfiguration.Builder builder()

    • serializableBuilderClass

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