Package software.amazon.awssdk.services.appstream.model

Class Theme

java.lang.Object

software.amazon.awssdk.services.appstream.model.Theme

All Implemented Interfaces:

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

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

The custom branding theme, which might include a custom logo, website links, and other branding to display to users.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Theme.Builder

Method Summary

Modifier and Type	Method	Description
static Theme.Builder	builder()
Instant	createdTime()	The time the theme was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasThemeFooterLinks()	For responses, this returns true if the service returned a value for the ThemeFooterLinks property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Theme.Builder>	serializableBuilderClass()
String	stackName()	The stack that has the custom branding theme.
ThemeState	state()	The state of the theme.
String	stateAsString()	The state of the theme.
String	themeFaviconURL()	The URL of the icon that displays at the top of a user's browser tab during streaming sessions.
List<ThemeFooterLink>	themeFooterLinks()	The website links that display in the catalog page footer.
String	themeOrganizationLogoURL()	The URL of the logo that displays in the catalog page header.
ThemeStyling	themeStyling()	The color that is used for the website links, text, buttons, and catalog page background.
String	themeStylingAsString()	The color that is used for the website links, text, buttons, and catalog page background.
String	themeTitleText()	The browser tab page title.
Theme.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

stackName

public final String stackName()

The stack that has the custom branding theme.

Returns:

The stack that has the custom branding theme.

state

public final ThemeState state()

The state of the theme.

If the service returns an enum value that is not available in the current SDK version, state will return ThemeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the theme.

See Also:

ThemeState

stateAsString

public final String stateAsString()

The state of the theme.

If the service returns an enum value that is not available in the current SDK version, state will return ThemeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the theme.

See Also:

ThemeState

themeTitleText

public final String themeTitleText()

The browser tab page title.

Returns:

The browser tab page title.

themeStyling

public final ThemeStyling themeStyling()

The color that is used for the website links, text, buttons, and catalog page background.

If the service returns an enum value that is not available in the current SDK version, themeStyling will return ThemeStyling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from themeStylingAsString().

Returns:

The color that is used for the website links, text, buttons, and catalog page background.

See Also:

ThemeStyling

themeStylingAsString

public final String themeStylingAsString()

The color that is used for the website links, text, buttons, and catalog page background.

If the service returns an enum value that is not available in the current SDK version, themeStyling will return ThemeStyling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from themeStylingAsString().

Returns:

The color that is used for the website links, text, buttons, and catalog page background.

See Also:

ThemeStyling

hasThemeFooterLinks

public final boolean hasThemeFooterLinks()

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

themeFooterLinks

public final List<ThemeFooterLink> themeFooterLinks()

The website links that display in the catalog page footer.

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

Returns:

The website links that display in the catalog page footer.

themeOrganizationLogoURL

public final String themeOrganizationLogoURL()

The URL of the logo that displays in the catalog page header.

Returns:

The URL of the logo that displays in the catalog page header.

themeFaviconURL

public final String themeFaviconURL()

The URL of the icon that displays at the top of a user's browser tab during streaming sessions.

Returns:

The URL of the icon that displays at the top of a user's browser tab during streaming sessions.

createdTime

public final Instant createdTime()

The time the theme was created.

Returns:

The time the theme was created.

toBuilder

public Theme.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Theme.Builder,Theme>

builder

public static Theme.Builder builder()

serializableBuilderClass

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