UserSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.workspacesweb.model.UserSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserSettings()

Constructors
Constructor and Description
`UserSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserSettings`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAssociatedPortalArns()` A list of web portal ARNs that this user settings is associated with.
`String`	`getCopyAllowed()` Specifies whether the user can copy text from the streaming session to the local device.
`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`	`setAssociatedPortalArns(Collection<String> associatedPortalArns)` A list of web portal ARNs that this user settings is associated with.
`void`	`setCopyAllowed(String copyAllowed)` Specifies whether the user can copy text from the streaming session to the local device.
`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`	`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`	`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`	`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserSettings
```
public UserSettings()
```
- Method Detail
  - getAssociatedPortalArns
```
public List<String> getAssociatedPortalArns()
```
    A list of web portal ARNs that this user settings is associated with.
    
    Returns:
    
    A list of web portal ARNs that this user settings is associated with.
  - setAssociatedPortalArns
```
public void setAssociatedPortalArns(Collection<String> associatedPortalArns)
```
    A list of web portal ARNs that this user settings is associated with.
    
    Parameters:
    
    associatedPortalArns - A list of web portal ARNs that this user settings is associated with.
  - withAssociatedPortalArns
```
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.
    
    Parameters:
    
    associatedPortalArns - A list of web portal ARNs that this user settings is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAssociatedPortalArns
```
public UserSettings withAssociatedPortalArns(Collection<String> associatedPortalArns)
```
    A list of web portal ARNs that this user settings is associated with.
    
    Parameters:
    
    associatedPortalArns - A list of web portal ARNs that this user settings is associated with.
    
    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 UserSettings 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 UserSettings 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
  - 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 UserSettings 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 UserSettings 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 UserSettings 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 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.
    
    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 UserSettings 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 UserSettings 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 UserSettings 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 UserSettings 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
  - 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 UserSettings 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 UserSettings 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
  - setUserSettingsArn
```
public void setUserSettingsArn(String userSettingsArn)
```
    The ARN of the user settings.
    
    Parameters:
    
    userSettingsArn - The ARN of the user settings.
  - getUserSettingsArn
```
public String getUserSettingsArn()
```
    The ARN of the user settings.
    
    Returns:
    
    The ARN of the user settings.
  - withUserSettingsArn
```
public UserSettings withUserSettingsArn(String userSettingsArn)
```
    The ARN of the user settings.
    
    Parameters:
    
    userSettingsArn - The ARN of the user settings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 UserSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class UserSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserSettings

Method Detail

getAssociatedPortalArns

setAssociatedPortalArns

withAssociatedPortalArns

withAssociatedPortalArns

setCopyAllowed

getCopyAllowed

withCopyAllowed

withCopyAllowed

setDisconnectTimeoutInMinutes

getDisconnectTimeoutInMinutes

withDisconnectTimeoutInMinutes

setDownloadAllowed

getDownloadAllowed

withDownloadAllowed

withDownloadAllowed

setIdleDisconnectTimeoutInMinutes

getIdleDisconnectTimeoutInMinutes

withIdleDisconnectTimeoutInMinutes

setPasteAllowed

getPasteAllowed

withPasteAllowed

withPasteAllowed

setPrintAllowed

getPrintAllowed

withPrintAllowed

withPrintAllowed

setUploadAllowed

getUploadAllowed

withUploadAllowed

withUploadAllowed

setUserSettingsArn

getUserSettingsArn

withUserSettingsArn

toString

equals

hashCode

clone

marshall