Package software.amazon.awssdk.services.quicksight.model

Class AnonymousUserQSearchBarEmbeddingConfiguration

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

The settings that you want to use with the Q search bar.

See Also:

  • Method Details

    • initialTopicId

      public final String initialTopicId()

      The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

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

      Returns:
      The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

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

    • toBuilder

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

    • builder

      public static AnonymousUserQSearchBarEmbeddingConfiguration.Builder builder()

    • serializableBuilderClass

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