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

Class SectionBasedLayoutPaperCanvasSizeOptions

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

The options for a paper canvas of a section-based layout.

See Also:

  • Method Details

    • paperSize

      public final PaperSize paperSize()

      The paper size that is used to define canvas dimensions.

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

      Returns:
      The paper size that is used to define canvas dimensions.
      See Also:

    • paperSizeAsString

      public final String paperSizeAsString()

      The paper size that is used to define canvas dimensions.

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

      Returns:
      The paper size that is used to define canvas dimensions.
      See Also:

    • paperOrientation

      public final PaperOrientation paperOrientation()

      The paper orientation that is used to define canvas dimensions. Choose one of the following options:

      • PORTRAIT

      • LANDSCAPE

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

      Returns:
      The paper orientation that is used to define canvas dimensions. Choose one of the following options:

      • PORTRAIT

      • LANDSCAPE

      See Also:

    • paperOrientationAsString

      public final String paperOrientationAsString()

      The paper orientation that is used to define canvas dimensions. Choose one of the following options:

      • PORTRAIT

      • LANDSCAPE

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

      Returns:
      The paper orientation that is used to define canvas dimensions. Choose one of the following options:

      • PORTRAIT

      • LANDSCAPE

      See Also:

    • paperMargin

      public final Spacing paperMargin()

      Defines the spacing between the canvas content and the top, bottom, left, and right edges.

      Returns:
      Defines the spacing between the canvas content and the top, bottom, left, and right edges.

    • toBuilder

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

    • builder

      public static SectionBasedLayoutPaperCanvasSizeOptions.Builder builder()

    • serializableBuilderClass

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