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(value="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 the Amazon QuickSight console. 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 and Description
static interface	Sheet.Builder

Method Summary

Modifier and Type	Method and Description
static Sheet.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of a sheet.
List<SdkField<?>>	sdkFields()
static Class<? extends Sheet.Builder>	serializableBuilderClass()
String	sheetId() The unique identifier associated with a sheet.
Sheet.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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.

toBuilder

public Sheet.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<Sheet.Builder,Sheet>

Returns:

a builder for type T

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)

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.