Class UserSettingsSummary

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

The summary of user settings.

See Also:

  • Method Details

    • userSettingsArn

      public final String userSettingsArn()

      The ARN of the user settings.

      Returns:
      The ARN of the user settings.

    • copyAllowed

      public final EnabledType copyAllowed()

      Specifies whether the user can copy text from the streaming session to the local device.

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

      Returns:
      Specifies whether the user can copy text from the streaming session to the local device.
      See Also:

    • copyAllowedAsString

      public final String copyAllowedAsString()

      Specifies whether the user can copy text from the streaming session to the local device.

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

      Returns:
      Specifies whether the user can copy text from the streaming session to the local device.
      See Also:

    • pasteAllowed

      public final EnabledType pasteAllowed()

      Specifies whether the user can paste text from the local device to the streaming session.

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

      Returns:
      Specifies whether the user can paste text from the local device to the streaming session.
      See Also:

    • pasteAllowedAsString

      public final String pasteAllowedAsString()

      Specifies whether the user can paste text from the local device to the streaming session.

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

      Returns:
      Specifies whether the user can paste text from the local device to the streaming session.
      See Also:

    • downloadAllowed

      public final EnabledType downloadAllowed()

      Specifies whether the user can download files from the streaming session to the local device.

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

      Returns:
      Specifies whether the user can download files from the streaming session to the local device.
      See Also:

    • downloadAllowedAsString

      public final String downloadAllowedAsString()

      Specifies whether the user can download files from the streaming session to the local device.

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

      Returns:
      Specifies whether the user can download files from the streaming session to the local device.
      See Also:

    • uploadAllowed

      public final EnabledType uploadAllowed()

      Specifies whether the user can upload files from the local device to the streaming session.

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

      Returns:
      Specifies whether the user can upload files from the local device to the streaming session.
      See Also:

    • uploadAllowedAsString

      public final String uploadAllowedAsString()

      Specifies whether the user can upload files from the local device to the streaming session.

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

      Returns:
      Specifies whether the user can upload files from the local device to the streaming session.
      See Also:

    • printAllowed

      public final EnabledType printAllowed()

      Specifies whether the user can print to the local device.

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

      Returns:
      Specifies whether the user can print to the local device.
      See Also:

    • printAllowedAsString

      public final String printAllowedAsString()

      Specifies whether the user can print to the local device.

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

      Returns:
      Specifies whether the user can print to the local device.
      See Also:

    • disconnectTimeoutInMinutes

      public final Integer disconnectTimeoutInMinutes()

      The amount of time that a streaming session remains active after users disconnect.

      Returns:
      The amount of time that a streaming session remains active after users disconnect.

    • idleDisconnectTimeoutInMinutes

      public final Integer idleDisconnectTimeoutInMinutes()

      The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

      Returns:
      The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

    • cookieSynchronizationConfiguration

      public final CookieSynchronizationConfiguration cookieSynchronizationConfiguration()

      The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

      Returns:
      The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

    • deepLinkAllowed

      public final EnabledType deepLinkAllowed()

      Specifies whether the user can use deep links that open automatically when connecting to a session.

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

      Returns:
      Specifies whether the user can use deep links that open automatically when connecting to a session.
      See Also:

    • deepLinkAllowedAsString

      public final String deepLinkAllowedAsString()

      Specifies whether the user can use deep links that open automatically when connecting to a session.

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

      Returns:
      Specifies whether the user can use deep links that open automatically when connecting to a session.
      See Also:

    • toolbarConfiguration

      public final ToolbarConfiguration 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.

      Returns:
      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.

    • toBuilder

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

    • builder

      public static UserSettingsSummary.Builder builder()

    • serializableBuilderClass

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