Class SheetDefinition
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SheetDefinition.Builder,
SheetDefinition>
A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SheetDefinition.Builder
builder()
final SheetContentType
The layout content type of the sheet.final String
The layout content type of the sheet.final String
A description of the sheet.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<FilterControl> The list of filter controls that are on a sheet.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the FilterControls property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Layouts property.final boolean
For responses, this returns true if the service returned a value for the ParameterControls property.final boolean
For responses, this returns true if the service returned a value for the SheetControlLayouts property.final boolean
For responses, this returns true if the service returned a value for the TextBoxes property.final boolean
For responses, this returns true if the service returned a value for the Visuals property.layouts()
Layouts define how the components of a sheet are arranged.final String
name()
The name of the sheet.final List
<ParameterControl> The list of parameter controls that are on a sheet.static Class
<? extends SheetDefinition.Builder> final List
<SheetControlLayout> The control layouts of the sheet.final String
sheetId()
The unique identifier of a sheet.final List
<SheetTextBox> The text boxes that are on a sheet.final String
title()
The title of the sheet.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.visuals()
A list of the visuals that are on a sheet.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
sheetId
The unique identifier of a sheet.
- Returns:
- The unique identifier of a sheet.
-
title
The title of the sheet.
- Returns:
- The title of the sheet.
-
description
A description of the sheet.
- Returns:
- A description of the sheet.
-
name
The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
- Returns:
- The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
-
hasParameterControls
public final boolean hasParameterControls()For responses, this returns true if the service returned a value for the ParameterControls property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
parameterControls
The list of parameter controls that are on a sheet.
For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.
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
hasParameterControls()
method.- Returns:
- The list of parameter controls that are on a sheet.
For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.
-
hasFilterControls
public final boolean hasFilterControls()For responses, this returns true if the service returned a value for the FilterControls property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
filterControls
The list of filter controls that are on a sheet.
For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.
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
hasFilterControls()
method.- Returns:
- The list of filter controls that are on a sheet.
For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.
-
hasVisuals
public final boolean hasVisuals()For responses, this returns true if the service returned a value for the Visuals property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
visuals
A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
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
hasVisuals()
method.- Returns:
- A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
-
hasTextBoxes
public final boolean hasTextBoxes()For responses, this returns true if the service returned a value for the TextBoxes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
textBoxes
The text boxes that are on a sheet.
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
hasTextBoxes()
method.- Returns:
- The text boxes that are on a sheet.
-
hasLayouts
public final boolean hasLayouts()For responses, this returns true if the service returned a value for the Layouts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
layouts
Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon QuickSight User Guide.
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
hasLayouts()
method.- Returns:
- Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon QuickSight User Guide.
-
hasSheetControlLayouts
public final boolean hasSheetControlLayouts()For responses, this returns true if the service returned a value for the SheetControlLayouts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
sheetControlLayouts
The control layouts of the sheet.
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
hasSheetControlLayouts()
method.- Returns:
- The control layouts of the sheet.
-
contentType
The layout content type of the sheet. Choose one of the following options:
-
PAGINATED
: Creates a sheet for a paginated report. -
INTERACTIVE
: Creates a sheet for an interactive dashboard.
If the service returns an enum value that is not available in the current SDK version,
contentType
will returnSheetContentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentTypeAsString()
.- Returns:
- The layout content type of the sheet. Choose one of the following options:
-
PAGINATED
: Creates a sheet for a paginated report. -
INTERACTIVE
: Creates a sheet for an interactive dashboard.
-
- See Also:
-
-
contentTypeAsString
The layout content type of the sheet. Choose one of the following options:
-
PAGINATED
: Creates a sheet for a paginated report. -
INTERACTIVE
: Creates a sheet for an interactive dashboard.
If the service returns an enum value that is not available in the current SDK version,
contentType
will returnSheetContentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentTypeAsString()
.- Returns:
- The layout content type of the sheet. Choose one of the following options:
-
PAGINATED
: Creates a sheet for a paginated report. -
INTERACTIVE
: Creates a sheet for an interactive dashboard.
-
- See Also:
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SheetDefinition.Builder,
SheetDefinition> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-