Class BrandingConfiguration

java.lang.Object
software.amazon.awssdk.services.workspacesweb.model.BrandingConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BrandingConfiguration.Builder,BrandingConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class BrandingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BrandingConfiguration.Builder,BrandingConfiguration>

The branding configuration output including custom images metadata, localized strings, color theme, and terms of service.

See Also:

  • Method Details

    • logo

      public final ImageMetadata logo()

      Metadata for the logo image file, including the MIME type, file extension, and upload timestamp.

      Returns:
      Metadata for the logo image file, including the MIME type, file extension, and upload timestamp.

    • wallpaper

      public final ImageMetadata wallpaper()

      Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp.

      Returns:
      Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp.

    • favicon

      public final ImageMetadata favicon()

      Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp.

      Returns:
      Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp.

    • localizedStrings

      public final Map<Locale,LocalizedBrandingStrings> localizedStrings()

      A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.

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

      Returns:
      A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.

    • hasLocalizedStrings

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

    • localizedStringsAsStrings

      public final Map<String,LocalizedBrandingStrings> localizedStringsAsStrings()

      A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.

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

      Returns:
      A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.

    • colorTheme

      public final ColorTheme colorTheme()

      The color theme for components on the web portal.

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

      Returns:
      The color theme for components on the web portal.
      See Also:

    • colorThemeAsString

      public final String colorThemeAsString()

      The color theme for components on the web portal.

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

      Returns:
      The color theme for components on the web portal.
      See Also:

    • termsOfService

      public final String termsOfService()

      The terms of service text in Markdown format that users must accept before accessing the portal.

      Returns:
      The terms of service text in Markdown format that users must accept before accessing the portal.

    • toBuilder

      public BrandingConfiguration.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<BrandingConfiguration.Builder,BrandingConfiguration>
      Returns:
      a builder for type T

    • builder

      public static BrandingConfiguration.Builder builder()

    • serializableBuilderClass

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