Interface BrandingConfigurationCreateInput.Builder

All Superinterfaces:
Buildable, CopyableBuilder<BrandingConfigurationCreateInput.Builder,BrandingConfigurationCreateInput>, SdkBuilder<BrandingConfigurationCreateInput.Builder,BrandingConfigurationCreateInput>, SdkPojo
Enclosing class:
BrandingConfigurationCreateInput
@Mutable @NotThreadSafe public static interface BrandingConfigurationCreateInput.Builder extends SdkPojo, CopyableBuilder<BrandingConfigurationCreateInput.Builder,BrandingConfigurationCreateInput>

  • Method Details

    • logo

      BrandingConfigurationCreateInput.Builder logo(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • logo

      default BrandingConfigurationCreateInput.Builder logo(Consumer<IconImageInput.Builder> 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.

      This is a convenience method that creates an instance of the IconImageInput.Builder avoiding the need to create one manually via IconImageInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logo(IconImageInput).

      Parameters:
      logo - a consumer that will call methods on IconImageInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • wallpaper

      BrandingConfigurationCreateInput.Builder wallpaper(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • wallpaper

      default BrandingConfigurationCreateInput.Builder wallpaper(Consumer<WallpaperImageInput.Builder> 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.

      This is a convenience method that creates an instance of the WallpaperImageInput.Builder avoiding the need to create one manually via WallpaperImageInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to wallpaper(WallpaperImageInput).

      Parameters:
      wallpaper - a consumer that will call methods on WallpaperImageInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • favicon

      BrandingConfigurationCreateInput.Builder favicon(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • favicon

      default BrandingConfigurationCreateInput.Builder favicon(Consumer<IconImageInput.Builder> 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.

      This is a convenience method that creates an instance of the IconImageInput.Builder avoiding the need to create one manually via IconImageInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to favicon(IconImageInput).

      Parameters:
      favicon - a consumer that will call methods on IconImageInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • localizedStringsWithStrings

      BrandingConfigurationCreateInput.Builder localizedStringsWithStrings(Map<String,LocalizedBrandingStrings> localizedStrings)

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

      Parameters:
      localizedStrings - A map of localized text strings for different supported languages. Each locale must provide the required fields browserTabTitle and welcomeText.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • localizedStrings

      BrandingConfigurationCreateInput.Builder localizedStrings(Map<Locale,LocalizedBrandingStrings> localizedStrings)

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

      Parameters:
      localizedStrings - A map of localized text strings for different supported languages. Each locale must provide the required fields browserTabTitle and welcomeText.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • colorTheme

      BrandingConfigurationCreateInput.Builder colorTheme(String colorTheme)

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

      Parameters:
      colorTheme - The color theme for components on the web portal. Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • colorTheme

      BrandingConfigurationCreateInput.Builder colorTheme(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.

      Parameters:
      colorTheme - The color theme for components on the web portal. Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • termsOfService

      BrandingConfigurationCreateInput.Builder termsOfService(String termsOfService)

      The terms of service text in Markdown format. Users will be presented with the terms of service after successfully signing in.

      Parameters:
      termsOfService - The terms of service text in Markdown format. Users will be presented with the terms of service after successfully signing in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.