software.amazon.awssdk.services.quicksight.model

Class SectionBasedLayoutConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.SectionBasedLayoutConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SectionBasedLayoutConfiguration.Builder,SectionBasedLayoutConfiguration>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SectionBasedLayoutConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
List<BodySectionConfiguration>	bodySections() A list of body section configurations.
static SectionBasedLayoutConfiguration.Builder	builder()
SectionBasedLayoutCanvasSizeOptions	canvasSizeOptions() The options for the canvas of a section-based layout.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<HeaderFooterSectionConfiguration>	footerSections() A list of footer section configurations.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBodySections() For responses, this returns true if the service returned a value for the BodySections property.
boolean	hasFooterSections() For responses, this returns true if the service returned a value for the FooterSections property.
int	hashCode()
boolean	hasHeaderSections() For responses, this returns true if the service returned a value for the HeaderSections property.
List<HeaderFooterSectionConfiguration>	headerSections() A list of header section configurations.
List<SdkField<?>>	sdkFields()
static Class<? extends SectionBasedLayoutConfiguration.Builder>	serializableBuilderClass()
SectionBasedLayoutConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<SectionBasedLayoutConfiguration.Builder,SectionBasedLayoutConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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