SheetDefinition (AWS Java SDK :: Services :: QuickSight 2.20.133 API)

java.lang.Object
- software.amazon.awssdk.services.quicksight.model.SheetDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SheetDefinition.Builder,SheetDefinition>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class SheetDefinition
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SheetDefinition.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SheetDefinition.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SheetDefinition.Builder`	`builder()`
`SheetContentType`	`contentType()` The layout content type of the sheet.
`String`	`contentTypeAsString()` The layout content type of the sheet.
`String`	`description()` A description of the sheet.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<FilterControl>`	`filterControls()` The list of filter controls that are on a sheet.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilterControls()` For responses, this returns true if the service returned a value for the FilterControls property.
`int`	`hashCode()`
`boolean`	`hasLayouts()` For responses, this returns true if the service returned a value for the Layouts property.
`boolean`	`hasParameterControls()` For responses, this returns true if the service returned a value for the ParameterControls property.
`boolean`	`hasSheetControlLayouts()` For responses, this returns true if the service returned a value for the SheetControlLayouts property.
`boolean`	`hasTextBoxes()` For responses, this returns true if the service returned a value for the TextBoxes property.
`boolean`	`hasVisuals()` For responses, this returns true if the service returned a value for the Visuals property.
`List<Layout>`	`layouts()` Layouts define how the components of a sheet are arranged.
`String`	`name()` The name of the sheet.
`List<ParameterControl>`	`parameterControls()` The list of parameter controls that are on a sheet.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SheetDefinition.Builder>`	`serializableBuilderClass()`
`List<SheetControlLayout>`	`sheetControlLayouts()` The control layouts of the sheet.
`String`	`sheetId()` The unique identifier of a sheet.
`List<SheetTextBox>`	`textBoxes()` The text boxes that are on a sheet.
`String`	`title()` The title of the sheet.
`SheetDefinition.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<Visual>`	`visuals()` A list of the visuals that are on a sheet.

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
  - sheetId
```
public final String sheetId()
```
    The unique identifier of a sheet.
    
    Returns:
    
    The unique identifier of a sheet.
  - title
```
public final String title()
```
    The title of the sheet.
    
    Returns:
    
    The title of the sheet.
  - description
```
public final String description()
```
    A description of the sheet.
    
    Returns:
    
    A description of the sheet.
  - name
```
public final String 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 the isEmpty() 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
```
public final List<ParameterControl> 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 the isEmpty() 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
```
public final List<FilterControl> 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 the isEmpty() 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
```
public final List<Visual> 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 the isEmpty() 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
```
public final List<SheetTextBox> 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 the isEmpty() 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
```
public final List<Layout> 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 the isEmpty() 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
```
public final List<SheetControlLayout> 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
```
public final SheetContentType 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 return SheetContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentTypeAsString().
    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:
    
    SheetContentType
  - contentTypeAsString
```
public final String 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 return SheetContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentTypeAsString().
    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:
    
    SheetContentType
  - toBuilder
```
public SheetDefinition.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SheetDefinition.Builder,SheetDefinition>
  - builder
```
public static SheetDefinition.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SheetDefinition.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

Class SheetDefinition

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

sheetId

title

description

name

hasParameterControls

parameterControls

hasFilterControls

filterControls

hasVisuals

visuals

hasTextBoxes

textBoxes

hasLayouts

layouts

hasSheetControlLayouts

sheetControlLayouts

contentType

contentTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields