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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UserSettings.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,String>	additionalEncryptionContext()	The additional encryption context of the user settings.
List<String>	associatedPortalArns()	A list of web portal ARNs that this user settings is associated with.
static UserSettings.Builder	builder()
CookieSynchronizationConfiguration	cookieSynchronizationConfiguration()	The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
EnabledType	copyAllowed()	Specifies whether the user can copy text from the streaming session to the local device.
String	copyAllowedAsString()	Specifies whether the user can copy text from the streaming session to the local device.
String	customerManagedKey()	The customer managed key used to encrypt sensitive information in the user settings.
Integer	disconnectTimeoutInMinutes()	The amount of time that a streaming session remains active after users disconnect.
EnabledType	downloadAllowed()	Specifies whether the user can download files from the streaming session to the local device.
String	downloadAllowedAsString()	Specifies whether the user can download files from the streaming session to the local device.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalEncryptionContext()	For responses, this returns true if the service returned a value for the AdditionalEncryptionContext property.
boolean	hasAssociatedPortalArns()	For responses, this returns true if the service returned a value for the AssociatedPortalArns property.
int	hashCode()
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.
EnabledType	pasteAllowed()	Specifies whether the user can paste text from the local device to the streaming session.
String	pasteAllowedAsString()	Specifies whether the user can paste text from the local device to the streaming session.
EnabledType	printAllowed()	Specifies whether the user can print to the local device.
String	printAllowedAsString()	Specifies whether the user can print to the local device.
List<SdkField<?>>	sdkFields()
static Class<? extends UserSettings.Builder>	serializableBuilderClass()
UserSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
EnabledType	uploadAllowed()	Specifies whether the user can upload files from the local device to the streaming session.
String	uploadAllowedAsString()	Specifies whether the user can upload files from the local device to the streaming session.
String	userSettingsArn()	The ARN of the user settings.

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

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:

EnabledType

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:

EnabledType

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:

EnabledType

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:

EnabledType

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:

EnabledType

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:

EnabledType

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:

EnabledType

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:

EnabledType

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:

EnabledType

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:

EnabledType

userSettingsArn

public final String userSettingsArn()

The ARN of the user settings.

Returns:

The ARN of the user settings.

toBuilder

public UserSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UserSettings.Builder,UserSettings>

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)

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