Class BrandingConfigurationUpdateInput

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

The input configuration for updating branding settings. All fields are optional when updating existing branding.

See Also:

  • Method Details

    • logo

      public final IconImageInput logo()

      The logo image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.

      Returns:
      The logo image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.

    • wallpaper

      public final WallpaperImageInput wallpaper()

      The wallpaper image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 5 MB in JPEG or PNG format.

      Returns:
      The wallpaper image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 5 MB in JPEG or PNG format.

    • favicon

      public final IconImageInput favicon()

      The favicon image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.

      Returns:
      The favicon image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.

    • localizedStrings

      public final Map<Locale,LocalizedBrandingStrings> localizedStrings()

      A map of localized text strings for different supported languages. Each locale must provide the required fields browserTabTitle and welcomeText.

      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 supported languages. Each locale must provide the required fields browserTabTitle and welcomeText.

    • 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 supported languages. Each locale must provide the required fields browserTabTitle and welcomeText.

      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 supported languages. Each locale must provide the required fields browserTabTitle and welcomeText.

    • colorTheme

      public final ColorTheme colorTheme()

      The color theme for components on the web portal. Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper.

      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. Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper.
      See Also:

    • colorThemeAsString

      public final String colorThemeAsString()

      The color theme for components on the web portal. Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper.

      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. Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper.
      See Also:

    • termsOfService

      public final String termsOfService()

      The terms of service text in Markdown format. To remove existing terms of service, provide an empty string.

      Returns:
      The terms of service text in Markdown format. To remove existing terms of service, provide an empty string.

    • toBuilder

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

    • builder

      public static BrandingConfigurationUpdateInput.Builder builder()

    • serializableBuilderClass

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