/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.quicksight.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* 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 AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SheetDefinition implements Serializable, Cloneable, StructuredPojo { /** ** The unique identifier of a sheet. *
*/ private String sheetId; /** ** The title of the sheet. *
*/ private String title; /** ** A description of the sheet. *
*/ private String description; /** ** The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console. *
*/ private String name; /** ** 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. *
*/ private java.util.List* 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. *
*/ private java.util.List* A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet. *
*/ private java.util.List* The text boxes that are on a sheet. *
*/ private java.util.List* Layouts define how the components of a sheet are arranged. *
** For more information, see Types * of layout in the Amazon QuickSight User Guide. *
*/ private java.util.List* The control layouts of the sheet. *
*/ private java.util.List* 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.
*
* The unique identifier of a sheet. *
* * @param sheetId * The unique identifier of a sheet. */ public void setSheetId(String sheetId) { this.sheetId = sheetId; } /** ** The unique identifier of a sheet. *
* * @return The unique identifier of a sheet. */ public String getSheetId() { return this.sheetId; } /** ** The unique identifier of a sheet. *
* * @param sheetId * The unique identifier of a sheet. * @return Returns a reference to this object so that method calls can be chained together. */ public SheetDefinition withSheetId(String sheetId) { setSheetId(sheetId); return this; } /** ** The title of the sheet. *
* * @param title * The title of the sheet. */ public void setTitle(String title) { this.title = title; } /** ** The title of the sheet. *
* * @return The title of the sheet. */ public String getTitle() { return this.title; } /** ** The title of the sheet. *
* * @param title * The title of the sheet. * @return Returns a reference to this object so that method calls can be chained together. */ public SheetDefinition withTitle(String title) { setTitle(title); return this; } /** ** A description of the sheet. *
* * @param description * A description of the sheet. */ public void setDescription(String description) { this.description = description; } /** ** A description of the sheet. *
* * @return A description of the sheet. */ public String getDescription() { return this.description; } /** ** A description of the sheet. *
* * @param description * A description of the sheet. * @return Returns a reference to this object so that method calls can be chained together. */ public SheetDefinition withDescription(String description) { setDescription(description); return this; } /** ** The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console. *
* * @param name * The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console. */ public void setName(String name) { this.name = name; } /** ** The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console. *
* * @return The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console. */ public String getName() { return this.name; } /** ** The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console. *
* * @param name * The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console. * @return Returns a reference to this object so that method calls can be chained together. */ public SheetDefinition withName(String name) { setName(name); return this; } /** ** 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. *
* * @return 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.
*/
public java.util.List
* 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.
*
* For more information, see Using a Control with a
* Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.
*/
public void setParameterControls(java.util.Collection
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setParameterControls(java.util.Collection)} or {@link #withParameterControls(java.util.Collection)} if
* you want to override the existing values.
*
* For more information, see Using a Control with a
* Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SheetDefinition withParameterControls(ParameterControl... parameterControls) {
if (this.parameterControls == null) {
setParameterControls(new java.util.ArrayList
* 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.
*
* For more information, see Using a Control with a
* Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SheetDefinition withParameterControls(java.util.Collection
* 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.
*
* For more information, see Adding filter controls to
* analysis sheets in the Amazon QuickSight User Guide.
*/
public java.util.List
* 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.
*
* For more information, see Adding filter controls to
* analysis sheets in the Amazon QuickSight User Guide.
*/
public void setFilterControls(java.util.Collection
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilterControls(java.util.Collection)} or {@link #withFilterControls(java.util.Collection)} if you want
* to override the existing values.
*
* For more information, see Adding filter controls to
* analysis sheets in the Amazon QuickSight User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SheetDefinition withFilterControls(FilterControl... filterControls) {
if (this.filterControls == null) {
setFilterControls(new java.util.ArrayList
* 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.
*
* For more information, see Adding filter controls to
* analysis sheets in the Amazon QuickSight User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SheetDefinition withFilterControls(java.util.Collection
* A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
*
* A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
*
* A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setVisuals(java.util.Collection)} or {@link #withVisuals(java.util.Collection)} if you want to override
* the existing values.
*
* A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
*
* The text boxes that are on a sheet.
*
* The text boxes that are on a sheet.
*
* The text boxes that are on a sheet.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTextBoxes(java.util.Collection)} or {@link #withTextBoxes(java.util.Collection)} if you want to
* override the existing values.
*
* The text boxes that are on a sheet.
*
* Layouts define how the components of a sheet are arranged.
*
* For more information, see Types
* of layout in the Amazon QuickSight User Guide.
*
* For more information, see Types of layout in the
* Amazon QuickSight User Guide.
*/
public java.util.List
* Layouts define how the components of a sheet are arranged.
*
* For more information, see Types
* of layout in the Amazon QuickSight User Guide.
*
* For more information, see Types of layout in the
* Amazon QuickSight User Guide.
*/
public void setLayouts(java.util.Collection
* Layouts define how the components of a sheet are arranged.
*
* For more information, see Types
* of layout in the Amazon QuickSight User Guide.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setLayouts(java.util.Collection)} or {@link #withLayouts(java.util.Collection)} if you want to override
* the existing values.
*
* For more information, see Types of layout in the
* Amazon QuickSight User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SheetDefinition withLayouts(Layout... layouts) {
if (this.layouts == null) {
setLayouts(new java.util.ArrayList
* Layouts define how the components of a sheet are arranged.
*
* For more information, see Types
* of layout in the Amazon QuickSight User Guide.
*
* For more information, see Types of layout in the
* Amazon QuickSight User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SheetDefinition withLayouts(java.util.Collection
* The control layouts of the sheet.
*
* The control layouts of the sheet.
*
* The control layouts of the sheet.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSheetControlLayouts(java.util.Collection)} or {@link #withSheetControlLayouts(java.util.Collection)}
* if you want to override the existing values.
*
* The control layouts of the sheet.
*
* The layout content type of the sheet. Choose one of the following options:
*
*
*
*
*
* @param 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.
*
* PAGINATED
: Creates a sheet for a paginated report.
*
* INTERACTIVE
: Creates a sheet for an interactive dashboard.
*
* 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.
*
* PAGINATED
: Creates a sheet for a paginated report.
*
* INTERACTIVE
: Creates a sheet for an interactive dashboard.
*
* 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.
*
* PAGINATED
: Creates a sheet for a paginated report.
*
* INTERACTIVE
: Creates a sheet for an interactive dashboard.
*
* 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.
*
* PAGINATED
: Creates a sheet for a paginated report.
*
* INTERACTIVE
: Creates a sheet for an interactive dashboard.
*