Interface TooltipSheetDefinition.Builder

All Superinterfaces:

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

Enclosing class:

TooltipSheetDefinition

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

Method Summary

Modifier and Type	Method	Description
TooltipSheetDefinition.Builder	images(Collection<SheetImage> images)	A list of images on a tooltip sheet.
TooltipSheetDefinition.Builder	images(Consumer<SheetImage.Builder>... images)	A list of images on a tooltip sheet.
TooltipSheetDefinition.Builder	images(SheetImage... images)	A list of images on a tooltip sheet.
TooltipSheetDefinition.Builder	layouts(Collection<Layout> layouts)	Layouts define how the components of a tooltip sheet are arranged.
TooltipSheetDefinition.Builder	layouts(Consumer<Layout.Builder>... layouts)	Layouts define how the components of a tooltip sheet are arranged.
TooltipSheetDefinition.Builder	layouts(Layout... layouts)	Layouts define how the components of a tooltip sheet are arranged.
TooltipSheetDefinition.Builder	name(String name)	The name of the tooltip sheet.
TooltipSheetDefinition.Builder	sheetId(String sheetId)	The unique identifier of a tooltip sheet.
TooltipSheetDefinition.Builder	textBoxes(Collection<SheetTextBox> textBoxes)	The text boxes that are on a tooltip sheet.
TooltipSheetDefinition.Builder	textBoxes(Consumer<SheetTextBox.Builder>... textBoxes)	The text boxes that are on a tooltip sheet.
TooltipSheetDefinition.Builder	textBoxes(SheetTextBox... textBoxes)	The text boxes that are on a tooltip sheet.
TooltipSheetDefinition.Builder	visuals(Collection<Visual> visuals)	A list of the visuals that are on a tooltip sheet.
TooltipSheetDefinition.Builder	visuals(Consumer<Visual.Builder>... visuals)	A list of the visuals that are on a tooltip sheet.
TooltipSheetDefinition.Builder	visuals(Visual... visuals)	A list of the visuals that are on a tooltip sheet.

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

sheetId

TooltipSheetDefinition.Builder sheetId(String sheetId)

The unique identifier of a tooltip sheet.

Parameters:

sheetId - The unique identifier of a tooltip sheet.

Returns:

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

name

TooltipSheetDefinition.Builder name(String name)

The name of the tooltip sheet. This name is displayed on the sheet's tab in the Quick console.

Parameters:

name - The name of the tooltip sheet. This name is displayed on the sheet's tab in the Quick console.

Returns:

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

visuals

TooltipSheetDefinition.Builder visuals(Collection<Visual> visuals)

A list of the visuals that are on a tooltip sheet.

Parameters:

visuals - A list of the visuals that are on a tooltip sheet.

Returns:

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

visuals

TooltipSheetDefinition.Builder visuals(Visual... visuals)

A list of the visuals that are on a tooltip sheet.

Parameters:

visuals - A list of the visuals that are on a tooltip sheet.

Returns:

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

visuals

TooltipSheetDefinition.Builder visuals(Consumer<Visual.Builder>... visuals)

A list of the visuals that are on a tooltip sheet.

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

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

Parameters:

visuals - a consumer that will call methods on Visual.Builder

Returns:

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

See Also:

• visuals(java.util.Collection<Visual>)

textBoxes

TooltipSheetDefinition.Builder textBoxes(Collection<SheetTextBox> textBoxes)

The text boxes that are on a tooltip sheet.

Parameters:

textBoxes - The text boxes that are on a tooltip sheet.

Returns:

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

textBoxes

TooltipSheetDefinition.Builder textBoxes(SheetTextBox... textBoxes)

The text boxes that are on a tooltip sheet.

Parameters:

textBoxes - The text boxes that are on a tooltip sheet.

Returns:

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

textBoxes

TooltipSheetDefinition.Builder textBoxes(Consumer<SheetTextBox.Builder>... textBoxes)

The text boxes that are on a tooltip sheet.

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

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

Parameters:

textBoxes - a consumer that will call methods on SheetTextBox.Builder

Returns:

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

See Also:

• textBoxes(java.util.Collection<SheetTextBox>)

images

TooltipSheetDefinition.Builder images(Collection<SheetImage> images)

A list of images on a tooltip sheet.

Parameters:

images - A list of images on a tooltip sheet.

Returns:

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

images

TooltipSheetDefinition.Builder images(SheetImage... images)

A list of images on a tooltip sheet.

Parameters:

images - A list of images on a tooltip sheet.

Returns:

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

images

TooltipSheetDefinition.Builder images(Consumer<SheetImage.Builder>... images)

A list of images on a tooltip sheet.

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

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

Parameters:

images - a consumer that will call methods on SheetImage.Builder

Returns:

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

See Also:

• images(java.util.Collection<SheetImage>)

layouts

TooltipSheetDefinition.Builder layouts(Collection<Layout> layouts)

Layouts define how the components of a tooltip sheet are arranged.

For more information, see Types of layout in the Amazon Quick Suite User Guide.

Parameters:

layouts - Layouts define how the components of a tooltip sheet are arranged.

For more information, see Types of layout in the Amazon Quick Suite User Guide.

Returns:

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

layouts

TooltipSheetDefinition.Builder layouts(Layout... layouts)

Layouts define how the components of a tooltip sheet are arranged.

For more information, see Types of layout in the Amazon Quick Suite User Guide.

Parameters:

layouts - Layouts define how the components of a tooltip sheet are arranged.

For more information, see Types of layout in the Amazon Quick Suite User Guide.

Returns:

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

layouts

TooltipSheetDefinition.Builder layouts(Consumer<Layout.Builder>... layouts)

Layouts define how the components of a tooltip sheet are arranged.

For more information, see Types of layout in the Amazon Quick Suite User Guide.

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

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

Parameters:

layouts - a consumer that will call methods on Layout.Builder

Returns:

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

See Also:

• layouts(java.util.Collection<Layout>)