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

Class SheetVisualScopingConfiguration

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

The filter that is applied to the options.

See Also:

  • Method Details

    • sheetId

      public final String sheetId()

      The selected sheet that the filter is applied to.

      Returns:
      The selected sheet that the filter is applied to.

    • scope

      public final FilterVisualScope scope()

      The scope of the applied entities. Choose one of the following options:

      • ALL_VISUALS

      • SELECTED_VISUALS

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

      Returns:
      The scope of the applied entities. Choose one of the following options:

      • ALL_VISUALS

      • SELECTED_VISUALS

      See Also:

    • scopeAsString

      public final String scopeAsString()

      The scope of the applied entities. Choose one of the following options:

      • ALL_VISUALS

      • SELECTED_VISUALS

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

      Returns:
      The scope of the applied entities. Choose one of the following options:

      • ALL_VISUALS

      • SELECTED_VISUALS

      See Also:

    • hasVisualIds

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

    • visualIds

      public final List<String> visualIds()

      The selected visuals that the filter is applied to.

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

      Returns:
      The selected visuals that the filter is applied to.

    • toBuilder

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

    • builder

      public static SheetVisualScopingConfiguration.Builder builder()

    • serializableBuilderClass

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