Class ParameterListControl

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

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

See Also:

  • Method Details

    • parameterControlId

      public final String parameterControlId()

      The ID of the ParameterListControl.

      Returns:
      The ID of the ParameterListControl.

    • title

      public final String title()

      The title of the ParameterListControl.

      Returns:
      The title of the ParameterListControl.

    • sourceParameterName

      public final String sourceParameterName()

      The source parameter name of the ParameterListControl.

      Returns:
      The source parameter name of the ParameterListControl.

    • displayOptions

      public final ListControlDisplayOptions displayOptions()

      The display options of a control.

      Returns:
      The display options of a control.

    • type

      public final SheetControlListType type()

      The type of ParameterListControl.

      If the service returns an enum value that is not available in the current SDK version, type will return SheetControlListType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of ParameterListControl.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of ParameterListControl.

      If the service returns an enum value that is not available in the current SDK version, type will return SheetControlListType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of ParameterListControl.
      See Also:

    • selectableValues

      public final ParameterSelectableValues selectableValues()

      A list of selectable values that are used in a control.

      Returns:
      A list of selectable values that are used in a control.

    • cascadingControlConfiguration

      public final CascadingControlConfiguration cascadingControlConfiguration()

      The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

      Returns:
      The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

    • hasControlSortConfigurations

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

    • controlSortConfigurations

      public final List<ControlSortConfiguration> controlSortConfigurations()

      The sort configuration for the values displayed in the control. Only one sort configuration can be applied per control.

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

      Returns:
      The sort configuration for the values displayed in the control. Only one sort configuration can be applied per control.

    • toBuilder

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

    • builder

      public static ParameterListControl.Builder builder()

    • serializableBuilderClass

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