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

Class GridLayoutScreenCanvasSizeOptions

java.lang.Object

software.amazon.awssdk.services.quicksight.model.GridLayoutScreenCanvasSizeOptions

All Implemented Interfaces:

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

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

The options that determine the sizing of the canvas used in a grid layout.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GridLayoutScreenCanvasSizeOptions.Builder

Method Summary

Modifier and Type	Method	Description
static GridLayoutScreenCanvasSizeOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	optimizedViewPortWidth()	The width that the view port will be optimized for when the layout renders.
ResizeOption	resizeOption()	This value determines the layout behavior when the viewport is resized.
String	resizeOptionAsString()	This value determines the layout behavior when the viewport is resized.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GridLayoutScreenCanvasSizeOptions.Builder>	serializableBuilderClass()
GridLayoutScreenCanvasSizeOptions.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

resizeOption

public final ResizeOption resizeOption()

This value determines the layout behavior when the viewport is resized.

• FIXED: A fixed width will be used when optimizing the layout. In the QuickSight console, this option is called Classic.

• RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the QuickSight console, this option is called Tiled.

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

Returns:

This value determines the layout behavior when the viewport is resized.

• FIXED: A fixed width will be used when optimizing the layout. In the QuickSight console, this option is called Classic.

• RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the QuickSight console, this option is called Tiled.

See Also:

ResizeOption

resizeOptionAsString

public final String resizeOptionAsString()

This value determines the layout behavior when the viewport is resized.

• FIXED: A fixed width will be used when optimizing the layout. In the QuickSight console, this option is called Classic.

• RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the QuickSight console, this option is called Tiled.

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

Returns:

This value determines the layout behavior when the viewport is resized.

• FIXED: A fixed width will be used when optimizing the layout. In the QuickSight console, this option is called Classic.

• RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the QuickSight console, this option is called Tiled.

See Also:

ResizeOption

optimizedViewPortWidth

public final String optimizedViewPortWidth()

The width that the view port will be optimized for when the layout renders.

Returns:

The width that the view port will be optimized for when the layout renders.

toBuilder

public GridLayoutScreenCanvasSizeOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GridLayoutScreenCanvasSizeOptions.Builder,GridLayoutScreenCanvasSizeOptions>

builder

public static GridLayoutScreenCanvasSizeOptions.Builder builder()

serializableBuilderClass

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