Class UserSetting

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

Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

See Also:

  • Method Details

    • action

      public final Action action()

      The action that is enabled or disabled.

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

      Returns:
      The action that is enabled or disabled.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action that is enabled or disabled.

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

      Returns:
      The action that is enabled or disabled.
      See Also:

    • permission

      public final Permission permission()

      Indicates whether the action is enabled or disabled.

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

      Returns:
      Indicates whether the action is enabled or disabled.
      See Also:

    • permissionAsString

      public final String permissionAsString()

      Indicates whether the action is enabled or disabled.

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

      Returns:
      Indicates whether the action is enabled or disabled.
      See Also:

    • maximumLength

      public final Integer maximumLength()

      Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.

      This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.

      This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.

      The value can be between 1 and 20,971,520 (20 MB).

      Returns:
      Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.

      This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.

      This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.

      The value can be between 1 and 20,971,520 (20 MB).

    • toBuilder

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

    • builder

      public static UserSetting.Builder builder()

    • serializableBuilderClass

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