Class SameSheetTargetVisualConfiguration

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

The configuration of the same-sheet target visuals that you want to be filtered.

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

See Also:

  • Method Details

    • hasTargetVisuals

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

    • targetVisuals

      public final List<String> targetVisuals()

      A list of the target visual IDs that are located in the same sheet of the analysis.

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

      Returns:
      A list of the target visual IDs that are located in the same sheet of the analysis.

    • targetVisualOptions

      public final TargetVisualOptions targetVisualOptions()

      The options that choose the target visual in the same sheet.

      Valid values are defined as follows:

      • ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.

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

      Returns:
      The options that choose the target visual in the same sheet.

      Valid values are defined as follows:

      • ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.

      See Also:

    • targetVisualOptionsAsString

      public final String targetVisualOptionsAsString()

      The options that choose the target visual in the same sheet.

      Valid values are defined as follows:

      • ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.

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

      Returns:
      The options that choose the target visual in the same sheet.

      Valid values are defined as follows:

      • ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.

      See Also:

    • toBuilder

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

    • builder

      public static SameSheetTargetVisualConfiguration.Builder builder()

    • serializableBuilderClass

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