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

Class SheetImageScalingConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.SheetImageScalingConfiguration

All Implemented Interfaces:

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

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

Determines how the image is scaled

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SheetImageScalingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static SheetImageScalingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
SheetImageScalingType	scalingType()	The scaling option to use when fitting the image inside the container.
String	scalingTypeAsString()	The scaling option to use when fitting the image inside the container.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SheetImageScalingConfiguration.Builder>	serializableBuilderClass()
SheetImageScalingConfiguration.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

scalingType

public final SheetImageScalingType scalingType()

The scaling option to use when fitting the image inside the container.

Valid values are defined as follows:

• SCALE_TO_WIDTH: The image takes up the entire width of the container. The image aspect ratio is preserved.

• SCALE_TO_HEIGHT: The image takes up the entire height of the container. The image aspect ratio is preserved.

• SCALE_TO_CONTAINER: The image takes up the entire width and height of the container. The image aspect ratio is not preserved.

• SCALE_NONE: The image is displayed in its original size and is not scaled to the container.

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

Returns:

The scaling option to use when fitting the image inside the container.

Valid values are defined as follows:

• SCALE_TO_WIDTH: The image takes up the entire width of the container. The image aspect ratio is preserved.

• SCALE_TO_HEIGHT: The image takes up the entire height of the container. The image aspect ratio is preserved.

• SCALE_TO_CONTAINER: The image takes up the entire width and height of the container. The image aspect ratio is not preserved.

• SCALE_NONE: The image is displayed in its original size and is not scaled to the container.

See Also:

SheetImageScalingType

scalingTypeAsString

public final String scalingTypeAsString()

The scaling option to use when fitting the image inside the container.

Valid values are defined as follows:

• SCALE_TO_WIDTH: The image takes up the entire width of the container. The image aspect ratio is preserved.

• SCALE_TO_HEIGHT: The image takes up the entire height of the container. The image aspect ratio is preserved.

• SCALE_TO_CONTAINER: The image takes up the entire width and height of the container. The image aspect ratio is not preserved.

• SCALE_NONE: The image is displayed in its original size and is not scaled to the container.

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

Returns:

The scaling option to use when fitting the image inside the container.

Valid values are defined as follows:

• SCALE_TO_WIDTH: The image takes up the entire width of the container. The image aspect ratio is preserved.

• SCALE_TO_HEIGHT: The image takes up the entire height of the container. The image aspect ratio is preserved.

• SCALE_TO_CONTAINER: The image takes up the entire width and height of the container. The image aspect ratio is not preserved.

• SCALE_NONE: The image is displayed in its original size and is not scaled to the container.

See Also:

SheetImageScalingType

toBuilder

public SheetImageScalingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SheetImageScalingConfiguration.Builder,SheetImageScalingConfiguration>

builder

public static SheetImageScalingConfiguration.Builder builder()

serializableBuilderClass

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