Class ToolbarConfiguration

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

The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.

See Also:

  • Method Details

    • toolbarType

      public final ToolbarType toolbarType()

      The type of toolbar displayed during the session.

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

      Returns:
      The type of toolbar displayed during the session.
      See Also:

    • toolbarTypeAsString

      public final String toolbarTypeAsString()

      The type of toolbar displayed during the session.

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

      Returns:
      The type of toolbar displayed during the session.
      See Also:

    • visualMode

      public final VisualMode visualMode()

      The visual mode of the toolbar.

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

      Returns:
      The visual mode of the toolbar.
      See Also:

    • visualModeAsString

      public final String visualModeAsString()

      The visual mode of the toolbar.

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

      Returns:
      The visual mode of the toolbar.
      See Also:

    • hiddenToolbarItems

      public final List<ToolbarItem> hiddenToolbarItems()

      The list of toolbar items to be hidden.

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

      Returns:
      The list of toolbar items to be hidden.

    • hasHiddenToolbarItems

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

    • hiddenToolbarItemsAsStrings

      public final List<String> hiddenToolbarItemsAsStrings()

      The list of toolbar items to be hidden.

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

      Returns:
      The list of toolbar items to be hidden.

    • maxDisplayResolution

      public final MaxDisplayResolution maxDisplayResolution()

      The maximum display resolution that is allowed for the session.

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

      Returns:
      The maximum display resolution that is allowed for the session.
      See Also:

    • maxDisplayResolutionAsString

      public final String maxDisplayResolutionAsString()

      The maximum display resolution that is allowed for the session.

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

      Returns:
      The maximum display resolution that is allowed for the session.
      See Also:

    • toBuilder

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

    • builder

      public static ToolbarConfiguration.Builder builder()

    • serializableBuilderClass

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