TemplateVersionDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.TemplateVersionDefinition

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TemplateVersionDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo

The detailed definition of a template.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TemplateVersionDefinition()

Constructors
Constructor and Description
`TemplateVersionDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TemplateVersionDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`AnalysisDefaults`	`getAnalysisDefaults()`
`List<CalculatedField>`	`getCalculatedFields()` An array of calculated field definitions for the template.
`List<ColumnConfiguration>`	`getColumnConfigurations()` An array of template-level column configurations.
`List<DataSetConfiguration>`	`getDataSetConfigurations()` An array of dataset configurations.
`List<FilterGroup>`	`getFilterGroups()` Filter definitions for a template.
`AssetOptions`	`getOptions()` An array of option definitions for a template.
`List<ParameterDeclaration>`	`getParameterDeclarations()` An array of parameter declarations for a template.
`List<SheetDefinition>`	`getSheets()` An array of sheet definitions for a template.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAnalysisDefaults(AnalysisDefaults analysisDefaults)`
`void`	`setCalculatedFields(Collection<CalculatedField> calculatedFields)` An array of calculated field definitions for the template.
`void`	`setColumnConfigurations(Collection<ColumnConfiguration> columnConfigurations)` An array of template-level column configurations.
`void`	`setDataSetConfigurations(Collection<DataSetConfiguration> dataSetConfigurations)` An array of dataset configurations.
`void`	`setFilterGroups(Collection<FilterGroup> filterGroups)` Filter definitions for a template.
`void`	`setOptions(AssetOptions options)` An array of option definitions for a template.
`void`	`setParameterDeclarations(Collection<ParameterDeclaration> parameterDeclarations)` An array of parameter declarations for a template.
`void`	`setSheets(Collection<SheetDefinition> sheets)` An array of sheet definitions for a template.
`String`	`toString()` Returns a string representation of this object.
`TemplateVersionDefinition`	`withAnalysisDefaults(AnalysisDefaults analysisDefaults)`
`TemplateVersionDefinition`	`withCalculatedFields(CalculatedField... calculatedFields)` An array of calculated field definitions for the template.
`TemplateVersionDefinition`	`withCalculatedFields(Collection<CalculatedField> calculatedFields)` An array of calculated field definitions for the template.
`TemplateVersionDefinition`	`withColumnConfigurations(Collection<ColumnConfiguration> columnConfigurations)` An array of template-level column configurations.
`TemplateVersionDefinition`	`withColumnConfigurations(ColumnConfiguration... columnConfigurations)` An array of template-level column configurations.
`TemplateVersionDefinition`	`withDataSetConfigurations(Collection<DataSetConfiguration> dataSetConfigurations)` An array of dataset configurations.
`TemplateVersionDefinition`	`withDataSetConfigurations(DataSetConfiguration... dataSetConfigurations)` An array of dataset configurations.
`TemplateVersionDefinition`	`withFilterGroups(Collection<FilterGroup> filterGroups)` Filter definitions for a template.
`TemplateVersionDefinition`	`withFilterGroups(FilterGroup... filterGroups)` Filter definitions for a template.
`TemplateVersionDefinition`	`withOptions(AssetOptions options)` An array of option definitions for a template.
`TemplateVersionDefinition`	`withParameterDeclarations(Collection<ParameterDeclaration> parameterDeclarations)` An array of parameter declarations for a template.
`TemplateVersionDefinition`	`withParameterDeclarations(ParameterDeclaration... parameterDeclarations)` An array of parameter declarations for a template.
`TemplateVersionDefinition`	`withSheets(Collection<SheetDefinition> sheets)` An array of sheet definitions for a template.
`TemplateVersionDefinition`	`withSheets(SheetDefinition... sheets)` An array of sheet definitions for a template.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TemplateVersionDefinition
```
public TemplateVersionDefinition()
```
- Method Detail
  - getDataSetConfigurations
```
public List<DataSetConfiguration> getDataSetConfigurations()
```
    An array of dataset configurations. These configurations define the required columns for each dataset used within a template.
    
    Returns:
    
    An array of dataset configurations. These configurations define the required columns for each dataset used within a template.
  - setDataSetConfigurations
```
public void setDataSetConfigurations(Collection<DataSetConfiguration> dataSetConfigurations)
```
    An array of dataset configurations. These configurations define the required columns for each dataset used within a template.
    
    Parameters:
    
    dataSetConfigurations - An array of dataset configurations. These configurations define the required columns for each dataset used within a template.
  - withDataSetConfigurations
```
public TemplateVersionDefinition withDataSetConfigurations(DataSetConfiguration... dataSetConfigurations)
```
    An array of dataset configurations. These configurations define the required columns for each dataset used within a template.
    
    NOTE: This method appends the values to the existing list (if any). Use setDataSetConfigurations(java.util.Collection) or withDataSetConfigurations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    dataSetConfigurations - An array of dataset configurations. These configurations define the required columns for each dataset used within a template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDataSetConfigurations
```
public TemplateVersionDefinition withDataSetConfigurations(Collection<DataSetConfiguration> dataSetConfigurations)
```
    An array of dataset configurations. These configurations define the required columns for each dataset used within a template.
    
    Parameters:
    
    dataSetConfigurations - An array of dataset configurations. These configurations define the required columns for each dataset used within a template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSheets
```
public List<SheetDefinition> getSheets()
```
    An array of sheet definitions for a template.
    
    Returns:
    
    An array of sheet definitions for a template.
  - setSheets
```
public void setSheets(Collection<SheetDefinition> sheets)
```
    An array of sheet definitions for a template.
    
    Parameters:
    
    sheets - An array of sheet definitions for a template.
  - withSheets
```
public TemplateVersionDefinition withSheets(SheetDefinition... sheets)
```
    An array of sheet definitions for a template.
    
    NOTE: This method appends the values to the existing list (if any). Use setSheets(java.util.Collection) or withSheets(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    sheets - An array of sheet definitions for a template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSheets
```
public TemplateVersionDefinition withSheets(Collection<SheetDefinition> sheets)
```
    An array of sheet definitions for a template.
    
    Parameters:
    
    sheets - An array of sheet definitions for a template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCalculatedFields
```
public List<CalculatedField> getCalculatedFields()
```
    An array of calculated field definitions for the template.
    
    Returns:
    
    An array of calculated field definitions for the template.
  - setCalculatedFields
```
public void setCalculatedFields(Collection<CalculatedField> calculatedFields)
```
    An array of calculated field definitions for the template.
    
    Parameters:
    
    calculatedFields - An array of calculated field definitions for the template.
  - withCalculatedFields
```
public TemplateVersionDefinition withCalculatedFields(CalculatedField... calculatedFields)
```
    An array of calculated field definitions for the template.
    
    NOTE: This method appends the values to the existing list (if any). Use setCalculatedFields(java.util.Collection) or withCalculatedFields(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    calculatedFields - An array of calculated field definitions for the template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCalculatedFields
```
public TemplateVersionDefinition withCalculatedFields(Collection<CalculatedField> calculatedFields)
```
    An array of calculated field definitions for the template.
    
    Parameters:
    
    calculatedFields - An array of calculated field definitions for the template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameterDeclarations
```
public List<ParameterDeclaration> getParameterDeclarations()
```
    An array of parameter declarations for a template.
    
    Parameters are named variables that can transfer a value for use by an action or an object.
    
    For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
    
    Returns:
    
    An array of parameter declarations for a template.
    
    Parameters are named variables that can transfer a value for use by an action or an object.
    
    For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
  - setParameterDeclarations
```
public void setParameterDeclarations(Collection<ParameterDeclaration> parameterDeclarations)
```
    An array of parameter declarations for a template.
    
    Parameters are named variables that can transfer a value for use by an action or an object.
    
    For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
    
    Parameters:
    
    parameterDeclarations - An array of parameter declarations for a template.
    
    Parameters are named variables that can transfer a value for use by an action or an object.
    
    For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
  - withParameterDeclarations
```
public TemplateVersionDefinition withParameterDeclarations(ParameterDeclaration... parameterDeclarations)
```
    An array of parameter declarations for a template.
    
    Parameters are named variables that can transfer a value for use by an action or an object.
    
    For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
    
    NOTE: This method appends the values to the existing list (if any). Use setParameterDeclarations(java.util.Collection) or withParameterDeclarations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    parameterDeclarations - An array of parameter declarations for a template.
    
    Parameters are named variables that can transfer a value for use by an action or an object.
    
    For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withParameterDeclarations
```
public TemplateVersionDefinition withParameterDeclarations(Collection<ParameterDeclaration> parameterDeclarations)
```
    An array of parameter declarations for a template.
    
    Parameters are named variables that can transfer a value for use by an action or an object.
    
    For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
    
    Parameters:
    
    parameterDeclarations - An array of parameter declarations for a template.
    
    Parameters are named variables that can transfer a value for use by an action or an object.
    
    For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFilterGroups
```
public List<FilterGroup> getFilterGroups()
```
    Filter definitions for a template.
    
    For more information, see Filtering Data in the Amazon QuickSight User Guide.
    
    Returns:
    
    Filter definitions for a template.
    
    For more information, see Filtering Data in the Amazon QuickSight User Guide.
  - setFilterGroups
```
public void setFilterGroups(Collection<FilterGroup> filterGroups)
```
    Filter definitions for a template.
    
    For more information, see Filtering Data in the Amazon QuickSight User Guide.
    
    Parameters:
    
    filterGroups - Filter definitions for a template.
    
    For more information, see Filtering Data in the Amazon QuickSight User Guide.
  - withFilterGroups
```
public TemplateVersionDefinition withFilterGroups(FilterGroup... filterGroups)
```
    Filter definitions for a template.
    
    For more information, see Filtering Data in the Amazon QuickSight User Guide.
    
    NOTE: This method appends the values to the existing list (if any). Use setFilterGroups(java.util.Collection) or withFilterGroups(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    filterGroups - Filter definitions for a template.
    
    For more information, see Filtering Data in the Amazon QuickSight User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFilterGroups
```
public TemplateVersionDefinition withFilterGroups(Collection<FilterGroup> filterGroups)
```
    Filter definitions for a template.
    
    For more information, see Filtering Data in the Amazon QuickSight User Guide.
    
    Parameters:
    
    filterGroups - Filter definitions for a template.
    
    For more information, see Filtering Data in the Amazon QuickSight User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getColumnConfigurations
```
public List<ColumnConfiguration> getColumnConfigurations()
```
    An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
    
    Returns:
    
    An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
  - setColumnConfigurations
```
public void setColumnConfigurations(Collection<ColumnConfiguration> columnConfigurations)
```
    An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
    
    Parameters:
    
    columnConfigurations - An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
  - withColumnConfigurations
```
public TemplateVersionDefinition withColumnConfigurations(ColumnConfiguration... columnConfigurations)
```
    An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
    
    NOTE: This method appends the values to the existing list (if any). Use setColumnConfigurations(java.util.Collection) or withColumnConfigurations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    columnConfigurations - An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withColumnConfigurations
```
public TemplateVersionDefinition withColumnConfigurations(Collection<ColumnConfiguration> columnConfigurations)
```
    An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
    
    Parameters:
    
    columnConfigurations - An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAnalysisDefaults
```
public void setAnalysisDefaults(AnalysisDefaults analysisDefaults)
```
    Parameters:
    
    analysisDefaults -
  - getAnalysisDefaults
```
public AnalysisDefaults getAnalysisDefaults()
```
    Returns:
  - withAnalysisDefaults
```
public TemplateVersionDefinition withAnalysisDefaults(AnalysisDefaults analysisDefaults)
```
    Parameters:
    
    analysisDefaults -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOptions
```
public void setOptions(AssetOptions options)
```
    An array of option definitions for a template.
    
    Parameters:
    
    options - An array of option definitions for a template.
  - getOptions
```
public AssetOptions getOptions()
```
    An array of option definitions for a template.
    
    Returns:
    
    An array of option definitions for a template.
  - withOptions
```
public TemplateVersionDefinition withOptions(AssetOptions options)
```
    An array of option definitions for a template.
    
    Parameters:
    
    options - An array of option definitions for a template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TemplateVersionDefinition clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class TemplateVersionDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TemplateVersionDefinition

Method Detail

getDataSetConfigurations

setDataSetConfigurations

withDataSetConfigurations

withDataSetConfigurations

getSheets

setSheets

withSheets

withSheets

getCalculatedFields

setCalculatedFields

withCalculatedFields

withCalculatedFields

getParameterDeclarations

setParameterDeclarations

withParameterDeclarations

withParameterDeclarations

getFilterGroups

setFilterGroups

withFilterGroups

withFilterGroups

getColumnConfigurations

setColumnConfigurations

withColumnConfigurations

withColumnConfigurations

setAnalysisDefaults

getAnalysisDefaults

withAnalysisDefaults

setOptions

getOptions

withOptions

toString

equals

hashCode

clone

marshall