Package software.amazon.awssdk.services.appstream.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UserSetting.Builder

Method Summary

Modifier and Type	Method	Description
Action	action()	The action that is enabled or disabled.
String	actionAsString()	The action that is enabled or disabled.
static UserSetting.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
Permission	permission()	Indicates whether the action is enabled or disabled.
String	permissionAsString()	Indicates whether the action is enabled or disabled.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UserSetting.Builder>	serializableBuilderClass()
UserSetting.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

Action

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:

Action

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:

Permission

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:

Permission

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()

Specified by:

toBuilder in interface ToCopyableBuilder<UserSetting.Builder,UserSetting>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo