Class UpdateThemeForStackRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.appstream.model.AppStreamRequest
software.amazon.awssdk.services.appstream.model.UpdateThemeForStackRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateThemeForStackRequest.Builder,UpdateThemeForStackRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateThemeForStackRequest extends AppStreamRequest implements ToCopyableBuilder<UpdateThemeForStackRequest.Builder,UpdateThemeForStackRequest>

  • Method Details

    • stackName

      public final String stackName()

      The name of the stack for the theme.

      Returns:
      The name of the stack for the theme.

    • hasFooterLinks

      public final boolean hasFooterLinks()
      For responses, this returns true if the service returned a value for the FooterLinks 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.

    • footerLinks

      public final List<ThemeFooterLink> footerLinks()

      The links that are displayed in the footer of the streaming application catalog page. These links are helpful resources for users, such as the organization's IT support and product marketing sites.

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

      Returns:
      The links that are displayed in the footer of the streaming application catalog page. These links are helpful resources for users, such as the organization's IT support and product marketing sites.

    • titleText

      public final String titleText()

      The title that is displayed at the top of the browser tab during users' application streaming sessions.

      Returns:
      The title that is displayed at the top of the browser tab during users' application streaming sessions.

    • themeStyling

      public final ThemeStyling themeStyling()

      The color theme that is applied to website links, text, and buttons. These colors are also applied as accents in the background for the streaming application catalog page.

      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 theme that is applied to website links, text, and buttons. These colors are also applied as accents in the background for the streaming application catalog page.
      See Also:

    • themeStylingAsString

      public final String themeStylingAsString()

      The color theme that is applied to website links, text, and buttons. These colors are also applied as accents in the background for the streaming application catalog page.

      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 theme that is applied to website links, text, and buttons. These colors are also applied as accents in the background for the streaming application catalog page.
      See Also:

    • organizationLogoS3Location

      public final S3Location organizationLogoS3Location()

      The organization logo that appears on the streaming application catalog page.

      Returns:
      The organization logo that appears on the streaming application catalog page.

    • faviconS3Location

      public final S3Location faviconS3Location()

      The S3 location of the favicon. The favicon enables users to recognize their application streaming site in a browser full of tabs or bookmarks. It is displayed at the top of the browser tab for the application streaming site during users' streaming sessions.

      Returns:
      The S3 location of the favicon. The favicon enables users to recognize their application streaming site in a browser full of tabs or bookmarks. It is displayed at the top of the browser tab for the application streaming site during users' streaming sessions.

    • state

      public final ThemeState state()

      Specifies whether custom branding should be applied to catalog page or not.

      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:
      Specifies whether custom branding should be applied to catalog page or not.
      See Also:

    • stateAsString

      public final String stateAsString()

      Specifies whether custom branding should be applied to catalog page or not.

      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:
      Specifies whether custom branding should be applied to catalog page or not.
      See Also:

    • attributesToDelete

      public final List<ThemeAttribute> attributesToDelete()

      The attributes to delete.

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

      Returns:
      The attributes to delete.

    • hasAttributesToDelete

      public final boolean hasAttributesToDelete()
      For responses, this returns true if the service returned a value for the AttributesToDelete 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.

    • attributesToDeleteAsStrings

      public final List<String> attributesToDeleteAsStrings()

      The attributes to delete.

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

      Returns:
      The attributes to delete.

    • toBuilder

      public UpdateThemeForStackRequest.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<UpdateThemeForStackRequest.Builder,UpdateThemeForStackRequest>
      Specified by:
      toBuilder in class AppStreamRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateThemeForStackRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateThemeForStackRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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