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

Class FilterControl

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

The control of a filter that is used to interact with a dashboard or an analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See Also:

  • Method Details

    • dateTimePicker

      public final FilterDateTimePickerControl dateTimePicker()

      A control from a date filter that is used to specify date and time.

      Returns:
      A control from a date filter that is used to specify date and time.

    • list

      public final FilterListControl list()

      A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

      Returns:
      A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

    • textField

      public final FilterTextFieldControl textField()

      A control to display a text box that is used to enter a single entry.

      Returns:
      A control to display a text box that is used to enter a single entry.

    • textArea

      public final FilterTextAreaControl textArea()

      A control to display a text box that is used to enter multiple entries.

      Returns:
      A control to display a text box that is used to enter multiple entries.

    • slider

      public final FilterSliderControl slider()

      A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

      Returns:
      A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

    • relativeDateTime

      public final FilterRelativeDateTimeControl relativeDateTime()

      A control from a date filter that is used to specify the relative date.

      Returns:
      A control from a date filter that is used to specify the relative date.

    • crossSheet

      public final FilterCrossSheetControl crossSheet()

      A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

      Returns:
      A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

    • toBuilder

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

    • builder

      public static FilterControl.Builder builder()

    • serializableBuilderClass

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