Class CreateThemeRequest

    • Method Detail

      • awsAccountId

        public final String awsAccountId()

        The ID of the Amazon Web Services account where you want to store the new theme.

        Returns:
        The ID of the Amazon Web Services account where you want to store the new theme.
      • themeId

        public final String themeId()

        An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.

        Returns:
        An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.
      • name

        public final String name()

        A display name for the theme.

        Returns:
        A display name for the theme.
      • baseThemeId

        public final String baseThemeId()

        The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.

        Returns:
        The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.
      • versionDescription

        public final String versionDescription()

        A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.

        Returns:
        A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.
      • configuration

        public final ThemeConfiguration configuration()

        The theme configuration, which contains the theme display properties.

        Returns:
        The theme configuration, which contains the theme display properties.
      • hasPermissions

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

        public final List<ResourcePermission> permissions()

        A valid grouping of resource permissions to apply to the new theme.

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

        Returns:
        A valid grouping of resource permissions to apply to the new theme.
      • hasTags

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

        public final List<Tag> tags()

        A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

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

        Returns:
        A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
      • 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