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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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<Theme.Builder,Theme>
      Returns:
      a builder for type T

    • 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)
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.