@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UserSettings extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
UserSettings() |
Modifier and Type | Method and Description |
---|---|
UserSettings |
addAdditionalEncryptionContextEntry(String key,
String value)
Add a single AdditionalEncryptionContext entry
|
UserSettings |
clearAdditionalEncryptionContextEntries()
Removes all the entries added into AdditionalEncryptionContext.
|
UserSettings |
clone() |
boolean |
equals(Object obj) |
Map<String,String> |
getAdditionalEncryptionContext()
The additional encryption context of the user settings.
|
List<String> |
getAssociatedPortalArns()
A list of web portal ARNs that this user settings is associated with.
|
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.
|
String |
getUploadAllowed()
Specifies whether the user can upload files from the local device to the streaming session.
|
String |
getUserSettingsArn()
The ARN of the user settings.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)
The additional encryption context of the user settings.
|
void |
setAssociatedPortalArns(Collection<String> associatedPortalArns)
A list of web portal ARNs that this user settings is associated with.
|
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 |
setUploadAllowed(String uploadAllowed)
Specifies whether the user can upload files from the local device to the streaming session.
|
void |
setUserSettingsArn(String userSettingsArn)
The ARN of the user settings.
|
String |
toString()
Returns a string representation of this object.
|
UserSettings |
withAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)
The additional encryption context of the user settings.
|
UserSettings |
withAssociatedPortalArns(Collection<String> associatedPortalArns)
A list of web portal ARNs that this user settings is associated with.
|
UserSettings |
withAssociatedPortalArns(String... associatedPortalArns)
A list of web portal ARNs that this user settings is associated with.
|
UserSettings |
withCookieSynchronizationConfiguration(CookieSynchronizationConfiguration cookieSynchronizationConfiguration)
The configuration that specifies which cookies should be synchronized from the end user's local browser to the
remote browser.
|
UserSettings |
withCopyAllowed(EnabledType copyAllowed)
Specifies whether the user can copy text from the streaming session to the local device.
|
UserSettings |
withCopyAllowed(String copyAllowed)
Specifies whether the user can copy text from the streaming session to the local device.
|
UserSettings |
withCustomerManagedKey(String customerManagedKey)
The customer managed key used to encrypt sensitive information in the user settings.
|
UserSettings |
withDeepLinkAllowed(EnabledType deepLinkAllowed)
Specifies whether the user can use deep links that open automatically when connecting to a session.
|
UserSettings |
withDeepLinkAllowed(String deepLinkAllowed)
Specifies whether the user can use deep links that open automatically when connecting to a session.
|
UserSettings |
withDisconnectTimeoutInMinutes(Integer disconnectTimeoutInMinutes)
The amount of time that a streaming session remains active after users disconnect.
|
UserSettings |
withDownloadAllowed(EnabledType downloadAllowed)
Specifies whether the user can download files from the streaming session to the local device.
|
UserSettings |
withDownloadAllowed(String downloadAllowed)
Specifies whether the user can download files from the streaming session to the local device.
|
UserSettings |
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.
|
UserSettings |
withPasteAllowed(EnabledType pasteAllowed)
Specifies whether the user can paste text from the local device to the streaming session.
|
UserSettings |
withPasteAllowed(String pasteAllowed)
Specifies whether the user can paste text from the local device to the streaming session.
|
UserSettings |
withPrintAllowed(EnabledType printAllowed)
Specifies whether the user can print to the local device.
|
UserSettings |
withPrintAllowed(String printAllowed)
Specifies whether the user can print to the local device.
|
UserSettings |
withUploadAllowed(EnabledType uploadAllowed)
Specifies whether the user can upload files from the local device to the streaming session.
|
UserSettings |
withUploadAllowed(String uploadAllowed)
Specifies whether the user can upload files from the local device to the streaming session.
|
UserSettings |
withUserSettingsArn(String userSettingsArn)
The ARN of the user settings.
|
public Map<String,String> getAdditionalEncryptionContext()
The additional encryption context of the user settings.
public void setAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)
The additional encryption context of the user settings.
additionalEncryptionContext
- The additional encryption context of the user settings.public UserSettings withAdditionalEncryptionContext(Map<String,String> additionalEncryptionContext)
The additional encryption context of the user settings.
additionalEncryptionContext
- The additional encryption context of the user settings.public UserSettings addAdditionalEncryptionContextEntry(String key, String value)
public UserSettings clearAdditionalEncryptionContextEntries()
public List<String> getAssociatedPortalArns()
A list of web portal ARNs that this user settings is associated with.
public void setAssociatedPortalArns(Collection<String> associatedPortalArns)
A list of web portal ARNs that this user settings is associated with.
associatedPortalArns
- A list of web portal ARNs that this user settings is associated with.public UserSettings withAssociatedPortalArns(String... associatedPortalArns)
A list of web portal ARNs that this user settings is associated with.
NOTE: This method appends the values to the existing list (if any). Use
setAssociatedPortalArns(java.util.Collection)
or withAssociatedPortalArns(java.util.Collection)
if you want to override the existing values.
associatedPortalArns
- A list of web portal ARNs that this user settings is associated with.public UserSettings withAssociatedPortalArns(Collection<String> associatedPortalArns)
A list of web portal ARNs that this user settings is associated with.
associatedPortalArns
- A list of web portal ARNs that this user settings is associated with.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.
cookieSynchronizationConfiguration
- The configuration that specifies which cookies should be synchronized from the end user's local browser to
the remote browser.public CookieSynchronizationConfiguration getCookieSynchronizationConfiguration()
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
public UserSettings withCookieSynchronizationConfiguration(CookieSynchronizationConfiguration cookieSynchronizationConfiguration)
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
cookieSynchronizationConfiguration
- The configuration that specifies which cookies should be synchronized from the end user's local browser to
the remote browser.public void setCopyAllowed(String copyAllowed)
Specifies whether the user can copy text from the streaming session to the local device.
copyAllowed
- Specifies whether the user can copy text from the streaming session to the local device.EnabledType
public String getCopyAllowed()
Specifies whether the user can copy text from the streaming session to the local device.
EnabledType
public UserSettings withCopyAllowed(String copyAllowed)
Specifies whether the user can copy text from the streaming session to the local device.
copyAllowed
- Specifies whether the user can copy text from the streaming session to the local device.EnabledType
public UserSettings withCopyAllowed(EnabledType copyAllowed)
Specifies whether the user can copy text from the streaming session to the local device.
copyAllowed
- Specifies whether the user can copy text from the streaming session to the local device.EnabledType
public void setCustomerManagedKey(String customerManagedKey)
The customer managed key used to encrypt sensitive information in the user settings.
customerManagedKey
- The customer managed key used to encrypt sensitive information in the user settings.public String getCustomerManagedKey()
The customer managed key used to encrypt sensitive information in the user settings.
public UserSettings withCustomerManagedKey(String customerManagedKey)
The customer managed key used to encrypt sensitive information in the user settings.
customerManagedKey
- The customer managed key used to encrypt sensitive information in the user settings.public void setDeepLinkAllowed(String deepLinkAllowed)
Specifies whether the user can use deep links that open automatically when connecting to a session.
deepLinkAllowed
- Specifies whether the user can use deep links that open automatically when connecting to a session.EnabledType
public String getDeepLinkAllowed()
Specifies whether the user can use deep links that open automatically when connecting to a session.
EnabledType
public UserSettings withDeepLinkAllowed(String deepLinkAllowed)
Specifies whether the user can use deep links that open automatically when connecting to a session.
deepLinkAllowed
- Specifies whether the user can use deep links that open automatically when connecting to a session.EnabledType
public UserSettings withDeepLinkAllowed(EnabledType deepLinkAllowed)
Specifies whether the user can use deep links that open automatically when connecting to a session.
deepLinkAllowed
- Specifies whether the user can use deep links that open automatically when connecting to a session.EnabledType
public void setDisconnectTimeoutInMinutes(Integer disconnectTimeoutInMinutes)
The amount of time that a streaming session remains active after users disconnect.
disconnectTimeoutInMinutes
- The amount of time that a streaming session remains active after users disconnect.public Integer getDisconnectTimeoutInMinutes()
The amount of time that a streaming session remains active after users disconnect.
public UserSettings withDisconnectTimeoutInMinutes(Integer disconnectTimeoutInMinutes)
The amount of time that a streaming session remains active after users disconnect.
disconnectTimeoutInMinutes
- The amount of time that a streaming session remains active after users disconnect.public void setDownloadAllowed(String downloadAllowed)
Specifies whether the user can download files from the streaming session to the local device.
downloadAllowed
- Specifies whether the user can download files from the streaming session to the local device.EnabledType
public String getDownloadAllowed()
Specifies whether the user can download files from the streaming session to the local device.
EnabledType
public UserSettings withDownloadAllowed(String downloadAllowed)
Specifies whether the user can download files from the streaming session to the local device.
downloadAllowed
- Specifies whether the user can download files from the streaming session to the local device.EnabledType
public UserSettings withDownloadAllowed(EnabledType downloadAllowed)
Specifies whether the user can download files from the streaming session to the local device.
downloadAllowed
- Specifies whether the user can download files from the streaming session to the local device.EnabledType
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.
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.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.
public UserSettings 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.
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.public void setPasteAllowed(String pasteAllowed)
Specifies whether the user can paste text from the local device to the streaming session.
pasteAllowed
- Specifies whether the user can paste text from the local device to the streaming session.EnabledType
public String getPasteAllowed()
Specifies whether the user can paste text from the local device to the streaming session.
EnabledType
public UserSettings withPasteAllowed(String pasteAllowed)
Specifies whether the user can paste text from the local device to the streaming session.
pasteAllowed
- Specifies whether the user can paste text from the local device to the streaming session.EnabledType
public UserSettings withPasteAllowed(EnabledType pasteAllowed)
Specifies whether the user can paste text from the local device to the streaming session.
pasteAllowed
- Specifies whether the user can paste text from the local device to the streaming session.EnabledType
public void setPrintAllowed(String printAllowed)
Specifies whether the user can print to the local device.
printAllowed
- Specifies whether the user can print to the local device.EnabledType
public String getPrintAllowed()
Specifies whether the user can print to the local device.
EnabledType
public UserSettings withPrintAllowed(String printAllowed)
Specifies whether the user can print to the local device.
printAllowed
- Specifies whether the user can print to the local device.EnabledType
public UserSettings withPrintAllowed(EnabledType printAllowed)
Specifies whether the user can print to the local device.
printAllowed
- Specifies whether the user can print to the local device.EnabledType
public void setUploadAllowed(String uploadAllowed)
Specifies whether the user can upload files from the local device to the streaming session.
uploadAllowed
- Specifies whether the user can upload files from the local device to the streaming session.EnabledType
public String getUploadAllowed()
Specifies whether the user can upload files from the local device to the streaming session.
EnabledType
public UserSettings withUploadAllowed(String uploadAllowed)
Specifies whether the user can upload files from the local device to the streaming session.
uploadAllowed
- Specifies whether the user can upload files from the local device to the streaming session.EnabledType
public UserSettings withUploadAllowed(EnabledType uploadAllowed)
Specifies whether the user can upload files from the local device to the streaming session.
uploadAllowed
- Specifies whether the user can upload files from the local device to the streaming session.EnabledType
public void setUserSettingsArn(String userSettingsArn)
The ARN of the user settings.
userSettingsArn
- The ARN of the user settings.public String getUserSettingsArn()
The ARN of the user settings.
public UserSettings withUserSettingsArn(String userSettingsArn)
The ARN of the user settings.
userSettingsArn
- The ARN of the user settings.public String toString()
toString
in class Object
Object.toString()
public UserSettings clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.