Class SectionBasedLayoutConfiguration

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

The configuration for a section-based layout.

See Also:

  • Method Details

    • hasHeaderSections

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

    • headerSections

      public final List<HeaderFooterSectionConfiguration> headerSections()

      A list of header section configurations.

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

      Returns:
      A list of header section configurations.

    • hasBodySections

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

    • bodySections

      public final List<BodySectionConfiguration> bodySections()

      A list of body section configurations.

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

      Returns:
      A list of body section configurations.

    • hasFooterSections

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

    • footerSections

      public final List<HeaderFooterSectionConfiguration> footerSections()

      A list of footer section configurations.

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

      Returns:
      A list of footer section configurations.

    • canvasSizeOptions

      public final SectionBasedLayoutCanvasSizeOptions canvasSizeOptions()

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

      Returns:
      The options for the canvas of a section-based layout.

    • toBuilder

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

    • builder

      public static SectionBasedLayoutConfiguration.Builder builder()

    • serializableBuilderClass

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