Interface SheetImage.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SheetImage.Builder,SheetImage>, SdkBuilder<SheetImage.Builder,SheetImage>, SdkPojo

Enclosing class:

SheetImage

@Mutable
@NotThreadSafe
public static interface SheetImage.Builder
extends SdkPojo, CopyableBuilder<SheetImage.Builder,SheetImage>

Method Summary

Modifier and Type	Method	Description
SheetImage.Builder	actions(Collection<ImageCustomAction> actions)	A list of custom actions that are configured for an image.
SheetImage.Builder	actions(Consumer<ImageCustomAction.Builder>... actions)	A list of custom actions that are configured for an image.
SheetImage.Builder	actions(ImageCustomAction... actions)	A list of custom actions that are configured for an image.
SheetImage.Builder	imageContentAltText(String imageContentAltText)	The alt text for the image.
default SheetImage.Builder	interactions(Consumer<ImageInteractionOptions.Builder> interactions)	The general image interactions setup for an image.
SheetImage.Builder	interactions(ImageInteractionOptions interactions)	The general image interactions setup for an image.
default SheetImage.Builder	scaling(Consumer<SheetImageScalingConfiguration.Builder> scaling)	Determines how the image is scaled.
SheetImage.Builder	scaling(SheetImageScalingConfiguration scaling)	Determines how the image is scaled.
SheetImage.Builder	sheetImageId(String sheetImageId)	The ID of the sheet image.
default SheetImage.Builder	source(Consumer<SheetImageSource.Builder> source)	The source of the image.
SheetImage.Builder	source(SheetImageSource source)	The source of the image.
default SheetImage.Builder	tooltip(Consumer<SheetImageTooltipConfiguration.Builder> tooltip)	The tooltip to be shown when hovering over the image.
SheetImage.Builder	tooltip(SheetImageTooltipConfiguration tooltip)	The tooltip to be shown when hovering over the image.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

sheetImageId

SheetImage.Builder sheetImageId(String sheetImageId)

The ID of the sheet image.

Parameters:

sheetImageId - The ID of the sheet image.

Returns:

Returns a reference to this object so that method calls can be chained together.

source

SheetImage.Builder source(SheetImageSource source)

The source of the image.

Parameters:

source - The source of the image.

Returns:

Returns a reference to this object so that method calls can be chained together.

source

default SheetImage.Builder source(Consumer<SheetImageSource.Builder> source)

The source of the image.

This is a convenience method that creates an instance of the SheetImageSource.Builder avoiding the need to create one manually via SheetImageSource.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to source(SheetImageSource).

Parameters:

source - a consumer that will call methods on SheetImageSource.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• source(SheetImageSource)

scaling

SheetImage.Builder scaling(SheetImageScalingConfiguration scaling)

Determines how the image is scaled.

Parameters:

scaling - Determines how the image is scaled.

Returns:

Returns a reference to this object so that method calls can be chained together.

scaling

default SheetImage.Builder scaling(Consumer<SheetImageScalingConfiguration.Builder> scaling)

Determines how the image is scaled.

This is a convenience method that creates an instance of the SheetImageScalingConfiguration.Builder avoiding the need to create one manually via SheetImageScalingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scaling(SheetImageScalingConfiguration).

Parameters:

scaling - a consumer that will call methods on SheetImageScalingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• scaling(SheetImageScalingConfiguration)

tooltip

SheetImage.Builder tooltip(SheetImageTooltipConfiguration tooltip)

The tooltip to be shown when hovering over the image.

Parameters:

tooltip - The tooltip to be shown when hovering over the image.

Returns:

Returns a reference to this object so that method calls can be chained together.

tooltip

default SheetImage.Builder tooltip(Consumer<SheetImageTooltipConfiguration.Builder> tooltip)

The tooltip to be shown when hovering over the image.

This is a convenience method that creates an instance of the SheetImageTooltipConfiguration.Builder avoiding the need to create one manually via SheetImageTooltipConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tooltip(SheetImageTooltipConfiguration).

Parameters:

tooltip - a consumer that will call methods on SheetImageTooltipConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• tooltip(SheetImageTooltipConfiguration)

imageContentAltText

SheetImage.Builder imageContentAltText(String imageContentAltText)

The alt text for the image.

Parameters:

imageContentAltText - The alt text for the image.

Returns:

Returns a reference to this object so that method calls can be chained together.

interactions

SheetImage.Builder interactions(ImageInteractionOptions interactions)

The general image interactions setup for an image.

Parameters:

interactions - The general image interactions setup for an image.

Returns:

Returns a reference to this object so that method calls can be chained together.

interactions

default SheetImage.Builder interactions(Consumer<ImageInteractionOptions.Builder> interactions)

The general image interactions setup for an image.

This is a convenience method that creates an instance of the ImageInteractionOptions.Builder avoiding the need to create one manually via ImageInteractionOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to interactions(ImageInteractionOptions).

Parameters:

interactions - a consumer that will call methods on ImageInteractionOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• interactions(ImageInteractionOptions)

actions

SheetImage.Builder actions(Collection<ImageCustomAction> actions)

A list of custom actions that are configured for an image.

Parameters:

actions - A list of custom actions that are configured for an image.

Returns:

Returns a reference to this object so that method calls can be chained together.

actions

SheetImage.Builder actions(ImageCustomAction... actions)

A list of custom actions that are configured for an image.

Parameters:

actions - A list of custom actions that are configured for an image.

Returns:

Returns a reference to this object so that method calls can be chained together.

actions

SheetImage.Builder actions(Consumer<ImageCustomAction.Builder>... actions)

A list of custom actions that are configured for an image.

This is a convenience method that creates an instance of the ImageCustomAction.Builder avoiding the need to create one manually via ImageCustomAction.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to actions(List<ImageCustomAction>).

Parameters:

actions - a consumer that will call methods on ImageCustomAction.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• actions(java.util.Collection<ImageCustomAction>)