Package software.amazon.awssdk.services.workspacesweb.model

Class UserSettings

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

A user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

See Also:

  • Method Details

    • hasAdditionalEncryptionContext

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

    • additionalEncryptionContext

      public final Map<String,String> additionalEncryptionContext()

      The additional encryption context of the user settings.

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

      Returns:
      The additional encryption context of the user settings.

    • hasAssociatedPortalArns

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

    • associatedPortalArns

      public final List<String> associatedPortalArns()

      A list of web portal ARNs that this user settings is associated with.

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

      Returns:
      A list of web portal ARNs that this user settings is associated with.

    • 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.

    • 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:

    • customerManagedKey

      public final String customerManagedKey()

      The customer managed key used to encrypt sensitive information in the user settings.

      Returns:
      The customer managed key used to encrypt sensitive information in the user settings.

    • 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.

    • 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:

    • 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.

    • 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:

    • 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:

    • 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:

    • userSettingsArn

      public final String userSettingsArn()

      The ARN of the user settings.

      Returns:
      The ARN of the user settings.

    • toBuilder

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

    • builder

      public static UserSettings.Builder builder()

    • serializableBuilderClass

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