software.amazon.awssdk.services.quicksight.model

Class AnalysisDefinition

java.lang.Object

software.amazon.awssdk.services.quicksight.model.AnalysisDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AnalysisDefinition.Builder,AnalysisDefinition>

@Generated(value="software.amazon.awssdk:codegen")
public final class AnalysisDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AnalysisDefinition.Builder,AnalysisDefinition>

The definition of an analysis.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AnalysisDefinition.Builder

Method Summary

Modifier and Type	Method and Description
AnalysisDefaults	analysisDefaults() Returns the value of the AnalysisDefaults property for this object.
static AnalysisDefinition.Builder	builder()
List<CalculatedField>	calculatedFields() An array of calculated field definitions for the analysis.
List<ColumnConfiguration>	columnConfigurations() An array of analysis-level column configurations.
List<DataSetIdentifierDeclaration>	dataSetIdentifierDeclarations() An array of dataset identifier declarations.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FilterGroup>	filterGroups() Filter definitions for an analysis.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCalculatedFields() For responses, this returns true if the service returned a value for the CalculatedFields property.
boolean	hasColumnConfigurations() For responses, this returns true if the service returned a value for the ColumnConfigurations property.
boolean	hasDataSetIdentifierDeclarations() For responses, this returns true if the service returned a value for the DataSetIdentifierDeclarations property.
boolean	hasFilterGroups() For responses, this returns true if the service returned a value for the FilterGroups property.
int	hashCode()
boolean	hasParameterDeclarations() For responses, this returns true if the service returned a value for the ParameterDeclarations property.
boolean	hasSheets() For responses, this returns true if the service returned a value for the Sheets property.
List<ParameterDeclaration>	parameterDeclarations() An array of parameter declarations for an analysis.
List<SdkField<?>>	sdkFields()
static Class<? extends AnalysisDefinition.Builder>	serializableBuilderClass()
List<SheetDefinition>	sheets() An array of sheet definitions for an analysis.
AnalysisDefinition.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hasDataSetIdentifierDeclarations

public final boolean hasDataSetIdentifierDeclarations()

For responses, this returns true if the service returned a value for the DataSetIdentifierDeclarations 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.

dataSetIdentifierDeclarations

public final List<DataSetIdentifierDeclaration> dataSetIdentifierDeclarations()

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.

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 hasDataSetIdentifierDeclarations() method.

Returns:

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.

hasSheets

public final boolean hasSheets()

For responses, this returns true if the service returned a value for the Sheets 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.

sheets

public final List<SheetDefinition> sheets()

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.

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 hasSheets() method.

Returns:

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.

hasCalculatedFields

public final boolean hasCalculatedFields()

For responses, this returns true if the service returned a value for the CalculatedFields 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.

calculatedFields

public final List<CalculatedField> calculatedFields()

An array of calculated field definitions for the analysis.

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 hasCalculatedFields() method.

Returns:

An array of calculated field definitions for the analysis.

hasParameterDeclarations

public final boolean hasParameterDeclarations()

For responses, this returns true if the service returned a value for the ParameterDeclarations 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.

parameterDeclarations

public final List<ParameterDeclaration> parameterDeclarations()

An array of parameter declarations for an analysis.

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.

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 hasParameterDeclarations() method.

Returns:

An array of parameter declarations for an analysis.

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.

hasFilterGroups

public final boolean hasFilterGroups()

For responses, this returns true if the service returned a value for the FilterGroups 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.

filterGroups

public final List<FilterGroup> filterGroups()

Filter definitions for an analysis.

For more information, see Filtering Data 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 hasFilterGroups() method.

Returns:

Filter definitions for an analysis.

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

hasColumnConfigurations

public final boolean hasColumnConfigurations()

For responses, this returns true if the service returned a value for the ColumnConfigurations 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.

columnConfigurations

public final List<ColumnConfiguration> columnConfigurations()

An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis.

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 hasColumnConfigurations() method.

Returns:

An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis.

analysisDefaults

public final AnalysisDefaults analysisDefaults()

Returns the value of the AnalysisDefaults property for this object.

Returns:

The value of the AnalysisDefaults property for this object.

toBuilder

public AnalysisDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalysisDefinition.Builder,AnalysisDefinition>

builder

public static AnalysisDefinition.Builder builder()

serializableBuilderClass

public static Class<? extends AnalysisDefinition.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