com.amazonaws.services.workspacesweb.model

Class CreateUserSettingsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workspacesweb.model.CreateUserSettingsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateUserSettingsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateUserSettingsRequest()

Method Summary

Modifier and Type	Method and Description
CreateUserSettingsRequest	addAdditionalEncryptionContextEntry(String key, String value) Add a single AdditionalEncryptionContext entry
CreateUserSettingsRequest	clearAdditionalEncryptionContextEntries() Removes all the entries added into AdditionalEncryptionContext.
CreateUserSettingsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Map<String,String>	getAdditionalEncryptionContext() The additional encryption context of the user settings.
String	getClientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CookieSynchronizationConfiguration	getCookieSynchronizationConfiguration() The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
String	getCopyAllowed() Specifies whether the user can copy text from the streaming session to the local device.
String	getCustomerManagedKey() The customer managed key used to encrypt sensitive information in the user settings.
String	getDeepLinkAllowed() Specifies whether the user can use deep links that open automatically when connecting to a session.
Integer	getDisconnectTimeoutInMinutes() The amount of time that a streaming session remains active after users disconnect.
String	getDownloadAllowed() Specifies whether the user can download files from the streaming session to the local device.
Integer	getIdleDisconnectTimeoutInMinutes() The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
String	getPasteAllowed() Specifies whether the user can paste text from the local device to the streaming session.
String	getPrintAllowed() Specifies whether the user can print to the local device.
List<Tag>	getTags() The tags to add to the user settings resource.
String	getUploadAllowed() Specifies whether the user can upload files from the local device to the streaming session.
int	hashCode()
void	setAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext) The additional encryption context of the user settings.
void	setClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setCookieSynchronizationConfiguration(CookieSynchronizationConfiguration cookieSynchronizationConfiguration) The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
void	setCopyAllowed(String copyAllowed) Specifies whether the user can copy text from the streaming session to the local device.
void	setCustomerManagedKey(String customerManagedKey) The customer managed key used to encrypt sensitive information in the user settings.
void	setDeepLinkAllowed(String deepLinkAllowed) Specifies whether the user can use deep links that open automatically when connecting to a session.
void	setDisconnectTimeoutInMinutes(Integer disconnectTimeoutInMinutes) The amount of time that a streaming session remains active after users disconnect.
void	setDownloadAllowed(String downloadAllowed) Specifies whether the user can download files from the streaming session to the local device.
void	setIdleDisconnectTimeoutInMinutes(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.
void	setPasteAllowed(String pasteAllowed) Specifies whether the user can paste text from the local device to the streaming session.
void	setPrintAllowed(String printAllowed) Specifies whether the user can print to the local device.
void	setTags(Collection<Tag> tags) The tags to add to the user settings resource.
void	setUploadAllowed(String uploadAllowed) Specifies whether the user can upload files from the local device to the streaming session.
String	toString() Returns a string representation of this object.
CreateUserSettingsRequest	withAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext) The additional encryption context of the user settings.
CreateUserSettingsRequest	withClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateUserSettingsRequest	withCookieSynchronizationConfiguration(CookieSynchronizationConfiguration cookieSynchronizationConfiguration) The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
CreateUserSettingsRequest	withCopyAllowed(EnabledType copyAllowed) Specifies whether the user can copy text from the streaming session to the local device.
CreateUserSettingsRequest	withCopyAllowed(String copyAllowed) Specifies whether the user can copy text from the streaming session to the local device.
CreateUserSettingsRequest	withCustomerManagedKey(String customerManagedKey) The customer managed key used to encrypt sensitive information in the user settings.
CreateUserSettingsRequest	withDeepLinkAllowed(EnabledType deepLinkAllowed) Specifies whether the user can use deep links that open automatically when connecting to a session.
CreateUserSettingsRequest	withDeepLinkAllowed(String deepLinkAllowed) Specifies whether the user can use deep links that open automatically when connecting to a session.
CreateUserSettingsRequest	withDisconnectTimeoutInMinutes(Integer disconnectTimeoutInMinutes) The amount of time that a streaming session remains active after users disconnect.
CreateUserSettingsRequest	withDownloadAllowed(EnabledType downloadAllowed) Specifies whether the user can download files from the streaming session to the local device.
CreateUserSettingsRequest	withDownloadAllowed(String downloadAllowed) Specifies whether the user can download files from the streaming session to the local device.
CreateUserSettingsRequest	withIdleDisconnectTimeoutInMinutes(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.
CreateUserSettingsRequest	withPasteAllowed(EnabledType pasteAllowed) Specifies whether the user can paste text from the local device to the streaming session.
CreateUserSettingsRequest	withPasteAllowed(String pasteAllowed) Specifies whether the user can paste text from the local device to the streaming session.
CreateUserSettingsRequest	withPrintAllowed(EnabledType printAllowed) Specifies whether the user can print to the local device.
CreateUserSettingsRequest	withPrintAllowed(String printAllowed) Specifies whether the user can print to the local device.
CreateUserSettingsRequest	withTags(Collection<Tag> tags) The tags to add to the user settings resource.
CreateUserSettingsRequest	withTags(Tag... tags) The tags to add to the user settings resource.
CreateUserSettingsRequest	withUploadAllowed(EnabledType uploadAllowed) Specifies whether the user can upload files from the local device to the streaming session.
CreateUserSettingsRequest	withUploadAllowed(String uploadAllowed) Specifies whether the user can upload files from the local device to the streaming session.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateUserSettingsRequest

public CreateUserSettingsRequest()

Method Detail

getAdditionalEncryptionContext

public Map<String,String> getAdditionalEncryptionContext()

The additional encryption context of the user settings.

Returns:

The additional encryption context of the user settings.

setAdditionalEncryptionContext

public void setAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)

The additional encryption context of the user settings.

Parameters:

additionalEncryptionContext - The additional encryption context of the user settings.

withAdditionalEncryptionContext

public CreateUserSettingsRequest withAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)

The additional encryption context of the user settings.

Parameters:

additionalEncryptionContext - The additional encryption context of the user settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

addAdditionalEncryptionContextEntry

public CreateUserSettingsRequest addAdditionalEncryptionContextEntry(String key,
                                                                     String value)

Add a single AdditionalEncryptionContext entry

See Also:

withAdditionalEncryptionContext(java.util.Map<java.lang.String, java.lang.String>)

clearAdditionalEncryptionContextEntries

public CreateUserSettingsRequest clearAdditionalEncryptionContextEntries()

Removes all the entries added into AdditionalEncryptionContext.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

getClientToken

public String getClientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

withClientToken

public CreateUserSettingsRequest withClientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCookieSynchronizationConfiguration

public void setCookieSynchronizationConfiguration(CookieSynchronizationConfiguration cookieSynchronizationConfiguration)

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

Parameters:

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

getCookieSynchronizationConfiguration

public CookieSynchronizationConfiguration getCookieSynchronizationConfiguration()

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.

withCookieSynchronizationConfiguration

public CreateUserSettingsRequest withCookieSynchronizationConfiguration(CookieSynchronizationConfiguration cookieSynchronizationConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setCopyAllowed

public void setCopyAllowed(String copyAllowed)

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

Parameters:

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

See Also:

EnabledType

getCopyAllowed

public String getCopyAllowed()

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

Returns:

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

See Also:

EnabledType

withCopyAllowed

public CreateUserSettingsRequest withCopyAllowed(String copyAllowed)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnabledType

withCopyAllowed

public CreateUserSettingsRequest withCopyAllowed(EnabledType copyAllowed)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnabledType

setCustomerManagedKey

public void setCustomerManagedKey(String customerManagedKey)

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

Parameters:

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

getCustomerManagedKey

public String getCustomerManagedKey()

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.

withCustomerManagedKey

public CreateUserSettingsRequest withCustomerManagedKey(String customerManagedKey)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeepLinkAllowed

public void setDeepLinkAllowed(String deepLinkAllowed)

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

Parameters:

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

See Also:

EnabledType

getDeepLinkAllowed

public String getDeepLinkAllowed()

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

Returns:

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

See Also:

EnabledType

withDeepLinkAllowed

public CreateUserSettingsRequest withDeepLinkAllowed(String deepLinkAllowed)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnabledType

withDeepLinkAllowed

public CreateUserSettingsRequest withDeepLinkAllowed(EnabledType deepLinkAllowed)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnabledType

setDisconnectTimeoutInMinutes

public void setDisconnectTimeoutInMinutes(Integer disconnectTimeoutInMinutes)

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

Parameters:

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

getDisconnectTimeoutInMinutes

public Integer getDisconnectTimeoutInMinutes()

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.

withDisconnectTimeoutInMinutes

public CreateUserSettingsRequest withDisconnectTimeoutInMinutes(Integer disconnectTimeoutInMinutes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDownloadAllowed

public void setDownloadAllowed(String downloadAllowed)

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

Parameters:

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

See Also:

EnabledType

getDownloadAllowed

public String getDownloadAllowed()

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

Returns:

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

See Also:

EnabledType

withDownloadAllowed

public CreateUserSettingsRequest withDownloadAllowed(String downloadAllowed)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnabledType

withDownloadAllowed

public CreateUserSettingsRequest withDownloadAllowed(EnabledType downloadAllowed)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnabledType

setIdleDisconnectTimeoutInMinutes

public void setIdleDisconnectTimeoutInMinutes(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.

Parameters:

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.

getIdleDisconnectTimeoutInMinutes

public Integer getIdleDisconnectTimeoutInMinutes()

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.

withIdleDisconnectTimeoutInMinutes

public CreateUserSettingsRequest withIdleDisconnectTimeoutInMinutes(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setPasteAllowed

public void setPasteAllowed(String pasteAllowed)

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

Parameters:

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

See Also:

EnabledType

getPasteAllowed

public String getPasteAllowed()

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

Returns:

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

See Also:

EnabledType

withPasteAllowed

public CreateUserSettingsRequest withPasteAllowed(String pasteAllowed)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnabledType

withPasteAllowed

public CreateUserSettingsRequest withPasteAllowed(EnabledType pasteAllowed)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnabledType

setPrintAllowed

public void setPrintAllowed(String printAllowed)

Specifies whether the user can print to the local device.

Parameters:

printAllowed - Specifies whether the user can print to the local device.

See Also:

EnabledType

getPrintAllowed

public String getPrintAllowed()

Specifies whether the user can print to the local device.

Returns:

Specifies whether the user can print to the local device.

See Also:

EnabledType

withPrintAllowed

public CreateUserSettingsRequest withPrintAllowed(String printAllowed)

Specifies whether the user can print to the local device.

Parameters:

printAllowed - Specifies whether the user can print to the local device.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnabledType

withPrintAllowed

public CreateUserSettingsRequest withPrintAllowed(EnabledType printAllowed)

Specifies whether the user can print to the local device.

Parameters:

printAllowed - Specifies whether the user can print to the local device.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnabledType

getTags

public List<Tag> getTags()

The tags to add to the user settings resource. A tag is a key-value pair.

Returns:

The tags to add to the user settings resource. A tag is a key-value pair.

setTags

public void setTags(Collection<Tag> tags)

The tags to add to the user settings resource. A tag is a key-value pair.

Parameters:

tags - The tags to add to the user settings resource. A tag is a key-value pair.

withTags

public CreateUserSettingsRequest withTags(Tag... tags)

The tags to add to the user settings resource. A tag is a key-value pair.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - The tags to add to the user settings resource. A tag is a key-value pair.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateUserSettingsRequest withTags(Collection<Tag> tags)

The tags to add to the user settings resource. A tag is a key-value pair.

Parameters:

tags - The tags to add to the user settings resource. A tag is a key-value pair.

Returns:

Returns a reference to this object so that method calls can be chained together.

setUploadAllowed

public void setUploadAllowed(String uploadAllowed)

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

Parameters:

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

See Also:

EnabledType

getUploadAllowed

public String getUploadAllowed()

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

Returns:

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

See Also:

EnabledType

withUploadAllowed

public CreateUserSettingsRequest withUploadAllowed(String uploadAllowed)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnabledType

withUploadAllowed

public CreateUserSettingsRequest withUploadAllowed(EnabledType uploadAllowed)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnabledType

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateUserSettingsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()