software.amazon.awssdk.services.quicksight.model

Class GridLayoutConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.GridLayoutConfiguration

All Implemented Interfaces:

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

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

The configuration for a grid layout. Also called a tiled 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GridLayoutConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static GridLayoutConfiguration.Builder	builder()
GridLayoutCanvasSizeOptions	canvasSizeOptions() Returns the value of the CanvasSizeOptions property for this object.
List<GridLayoutElement>	elements() The elements that are included in a grid layout.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasElements() For responses, this returns true if the service returned a value for the Elements property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends GridLayoutConfiguration.Builder>	serializableBuilderClass()
GridLayoutConfiguration.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

hasElements

public final boolean hasElements()

For responses, this returns true if the service returned a value for the Elements 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.

elements

public final List<GridLayoutElement> elements()

The elements that are included in a grid layout.

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

Returns:

The elements that are included in a grid layout.

canvasSizeOptions

public final GridLayoutCanvasSizeOptions canvasSizeOptions()

Returns the value of the CanvasSizeOptions property for this object.

Returns:

The value of the CanvasSizeOptions property for this object.

toBuilder

public GridLayoutConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GridLayoutConfiguration.Builder,GridLayoutConfiguration>

builder

public static GridLayoutConfiguration.Builder builder()

serializableBuilderClass

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