Package software.amazon.awssdk.services.quicksight.model

Class Sheet

java.lang.Object

software.amazon.awssdk.services.quicksight.model.Sheet

All Implemented Interfaces:

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

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

A sheet, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Sheet.Builder

Method Summary

Modifier and Type	Method	Description
static Sheet.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasImages()	For responses, this returns true if the service returned a value for the Images property.
List<SheetImage>	images()	A list of images on a sheet.
String	name()	The name of a sheet.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Sheet.Builder>	serializableBuilderClass()
String	sheetId()	The unique identifier associated with a sheet.
Sheet.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

sheetId

public final String sheetId()

The unique identifier associated with a sheet.

Returns:

The unique identifier associated with a sheet.

name

public final String name()

The name of a sheet. This name is displayed on the sheet's tab in the QuickSight console.

Returns:

The name of a sheet. This name is displayed on the sheet's tab in the QuickSight console.

hasImages

public final boolean hasImages()

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

images

public final List<SheetImage> images()

A list of images 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 hasImages() method.

Returns:

A list of images on a sheet.

toBuilder

public Sheet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Sheet.Builder,Sheet>

builder

public static Sheet.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo