Class SheetDefinition

java.lang.Object
software.amazon.awssdk.services.quicksight.model.SheetDefinition
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SheetDefinition.Builder,SheetDefinition>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public SheetDefinition.Builder 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 interface ToCopyableBuilder<SheetDefinition.Builder,SheetDefinition>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.