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

Class LayoutConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.LayoutConfiguration

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class LayoutConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LayoutConfiguration.Builder,LayoutConfiguration>

The configuration that determines what the type of layout will be used on a sheet.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LayoutConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static LayoutConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FreeFormLayoutConfiguration	freeFormLayout()	A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
GridLayoutConfiguration	gridLayout()	A type of layout that can be used on a sheet.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
SectionBasedLayoutConfiguration	sectionBasedLayout()	A section based layout organizes visuals into multiple sections and has customized header, footer and page break.
static Class<? extends LayoutConfiguration.Builder>	serializableBuilderClass()
LayoutConfiguration.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

gridLayout

public final GridLayoutConfiguration gridLayout()

A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE.

Returns:

A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE.

freeFormLayout

public final FreeFormLayoutConfiguration freeFormLayout()

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

Returns:

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

sectionBasedLayout

public final SectionBasedLayoutConfiguration sectionBasedLayout()

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

Returns:

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

toBuilder

public LayoutConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LayoutConfiguration.Builder,LayoutConfiguration>

builder

public static LayoutConfiguration.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo