Class GridLayoutScreenCanvasSizeOptions

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

The options that determine the sizing of the canvas used in a grid layout.

See Also:

  • Method Details

    • resizeOption

      public final ResizeOption resizeOption()

      This value determines the layout behavior when the viewport is resized.

      • FIXED: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called Classic.

      • RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled.

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

      Returns:
      This value determines the layout behavior when the viewport is resized.

      • FIXED: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called Classic.

      • RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled.

      See Also:

    • resizeOptionAsString

      public final String resizeOptionAsString()

      This value determines the layout behavior when the viewport is resized.

      • FIXED: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called Classic.

      • RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled.

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

      Returns:
      This value determines the layout behavior when the viewport is resized.

      • FIXED: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called Classic.

      • RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled.

      See Also:

    • optimizedViewPortWidth

      public final String optimizedViewPortWidth()

      The width that the view port will be optimized for when the layout renders.

      Returns:
      The width that the view port will be optimized for when the layout renders.

    • toBuilder

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

    • builder

      public static GridLayoutScreenCanvasSizeOptions.Builder builder()

    • serializableBuilderClass

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