java.lang.Object
- software.amazon.awssdk.services.quicksight.model.SheetImage

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<SheetImage.Builder,SheetImage>

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

An image that is located on a sheet.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SheetImage.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<ImageCustomAction>`	`actions()`	A list of custom actions that are configured for an image.
`static SheetImage.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasActions()`	For responses, this returns true if the service returned a value for the Actions property.
`int`	`hashCode()`
`String`	`imageContentAltText()`	The alt text for the image.
`ImageInteractionOptions`	`interactions()`	The general image interactions setup for an image.
`SheetImageScalingConfiguration`	`scaling()`	Determines how the image is scaled.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SheetImage.Builder>`	`serializableBuilderClass()`
`String`	`sheetImageId()`	The ID of the sheet image.
`SheetImageSource`	`source()`	The source of the image.
`SheetImage.Builder`	`toBuilder()`
`SheetImageTooltipConfiguration`	`tooltip()`	The tooltip to be shown when hovering over the image.
`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
  - sheetImageId
```
public final String sheetImageId()
```
    The ID of the sheet image.
    
    Returns:
    
    The ID of the sheet image.
  - source
```
public final SheetImageSource source()
```
    The source of the image.
    
    Returns:
    
    The source of the image.
  - scaling
```
public final SheetImageScalingConfiguration scaling()
```
    Determines how the image is scaled.
    
    Returns:
    
    Determines how the image is scaled.
  - tooltip
```
public final SheetImageTooltipConfiguration tooltip()
```
    The tooltip to be shown when hovering over the image.
    
    Returns:
    
    The tooltip to be shown when hovering over the image.
  - imageContentAltText
```
public final String imageContentAltText()
```
    The alt text for the image.
    
    Returns:
    
    The alt text for the image.
  - interactions
```
public final ImageInteractionOptions interactions()
```
    The general image interactions setup for an image.
    
    Returns:
    
    The general image interactions setup for an image.
  - hasActions
```
public final boolean hasActions()
```
    For responses, this returns true if the service returned a value for the Actions 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.
  - actions
```
public final List<ImageCustomAction> actions()
```
    A list of custom actions that are configured for an image.
    
    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 hasActions() method.
    
    Returns:
    
    A list of custom actions that are configured for an image.
  - toBuilder
```
public SheetImage.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SheetImage.Builder,SheetImage>
  - builder
```
public static SheetImage.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SheetImage.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

Class SheetImage

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

sheetImageId

source

scaling

tooltip

imageContentAltText

interactions

hasActions

actions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField