StreamConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.nimblestudio.model.StreamConfiguration

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

A configuration for a streaming session.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StreamConfiguration()

Constructors
Constructor and Description
`StreamConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StreamConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getClipboardMode()` Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
`List<String>`	`getEc2InstanceTypes()` The EC2 instance types that users can select from when launching a streaming session with this launch profile.
`Integer`	`getMaxSessionLengthInMinutes()` The length of time, in minutes, that a streaming session can be active before it is stopped or terminated.
`Integer`	`getMaxStoppedSessionLengthInMinutes()` Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state.
`StreamConfigurationSessionStorage`	`getSessionStorage()` (Optional) The upload storage for a streaming session.
`List<String>`	`getStreamingImageIds()` The streaming images that users can select from when launching a streaming session with this launch profile.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setClipboardMode(String clipboardMode)` Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
`void`	`setEc2InstanceTypes(Collection<String> ec2InstanceTypes)` The EC2 instance types that users can select from when launching a streaming session with this launch profile.
`void`	`setMaxSessionLengthInMinutes(Integer maxSessionLengthInMinutes)` The length of time, in minutes, that a streaming session can be active before it is stopped or terminated.
`void`	`setMaxStoppedSessionLengthInMinutes(Integer maxStoppedSessionLengthInMinutes)` Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state.
`void`	`setSessionStorage(StreamConfigurationSessionStorage sessionStorage)` (Optional) The upload storage for a streaming session.
`void`	`setStreamingImageIds(Collection<String> streamingImageIds)` The streaming images that users can select from when launching a streaming session with this launch profile.
`String`	`toString()` Returns a string representation of this object.
`StreamConfiguration`	`withClipboardMode(StreamingClipboardMode clipboardMode)` Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
`StreamConfiguration`	`withClipboardMode(String clipboardMode)` Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
`StreamConfiguration`	`withEc2InstanceTypes(Collection<String> ec2InstanceTypes)` The EC2 instance types that users can select from when launching a streaming session with this launch profile.
`StreamConfiguration`	`withEc2InstanceTypes(StreamingInstanceType... ec2InstanceTypes)` The EC2 instance types that users can select from when launching a streaming session with this launch profile.
`StreamConfiguration`	`withEc2InstanceTypes(String... ec2InstanceTypes)` The EC2 instance types that users can select from when launching a streaming session with this launch profile.
`StreamConfiguration`	`withMaxSessionLengthInMinutes(Integer maxSessionLengthInMinutes)` The length of time, in minutes, that a streaming session can be active before it is stopped or terminated.
`StreamConfiguration`	`withMaxStoppedSessionLengthInMinutes(Integer maxStoppedSessionLengthInMinutes)` Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state.
`StreamConfiguration`	`withSessionStorage(StreamConfigurationSessionStorage sessionStorage)` (Optional) The upload storage for a streaming session.
`StreamConfiguration`	`withStreamingImageIds(Collection<String> streamingImageIds)` The streaming images that users can select from when launching a streaming session with this launch profile.
`StreamConfiguration`	`withStreamingImageIds(String... streamingImageIds)` The streaming images that users can select from when launching a streaming session with this launch profile.

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

- Constructor Detail
  - StreamConfiguration
```
public StreamConfiguration()
```
- Method Detail
  - setClipboardMode
```
public void setClipboardMode(String clipboardMode)
```
    Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
    
    Parameters:
    
    clipboardMode - Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
    
    See Also:
    
    StreamingClipboardMode
  - getClipboardMode
```
public String getClipboardMode()
```
    Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
    
    Returns:
    
    Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
    
    See Also:
    
    StreamingClipboardMode
  - withClipboardMode
```
public StreamConfiguration withClipboardMode(String clipboardMode)
```
    Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
    
    Parameters:
    
    clipboardMode - Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamingClipboardMode
  - withClipboardMode
```
public StreamConfiguration withClipboardMode(StreamingClipboardMode clipboardMode)
```
    Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
    
    Parameters:
    
    clipboardMode - Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamingClipboardMode
  - getEc2InstanceTypes
```
public List<String> getEc2InstanceTypes()
```
    The EC2 instance types that users can select from when launching a streaming session with this launch profile.
    
    Returns:
    
    The EC2 instance types that users can select from when launching a streaming session with this launch profile.
    
    See Also:
    
    StreamingInstanceType
  - setEc2InstanceTypes
```
public void setEc2InstanceTypes(Collection<String> ec2InstanceTypes)
```
    The EC2 instance types that users can select from when launching a streaming session with this launch profile.
    
    Parameters:
    
    ec2InstanceTypes - The EC2 instance types that users can select from when launching a streaming session with this launch profile.
    
    See Also:
    
    StreamingInstanceType
  - withEc2InstanceTypes
```
public StreamConfiguration withEc2InstanceTypes(String... ec2InstanceTypes)
```
    The EC2 instance types that users can select from when launching a streaming session with this launch profile.
    
    NOTE: This method appends the values to the existing list (if any). Use setEc2InstanceTypes(java.util.Collection) or withEc2InstanceTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ec2InstanceTypes - The EC2 instance types that users can select from when launching a streaming session with this launch profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamingInstanceType
  - withEc2InstanceTypes
```
public StreamConfiguration withEc2InstanceTypes(Collection<String> ec2InstanceTypes)
```
    The EC2 instance types that users can select from when launching a streaming session with this launch profile.
    
    Parameters:
    
    ec2InstanceTypes - The EC2 instance types that users can select from when launching a streaming session with this launch profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamingInstanceType
  - withEc2InstanceTypes
```
public StreamConfiguration withEc2InstanceTypes(StreamingInstanceType... ec2InstanceTypes)
```
    The EC2 instance types that users can select from when launching a streaming session with this launch profile.
    
    Parameters:
    
    ec2InstanceTypes - The EC2 instance types that users can select from when launching a streaming session with this launch profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamingInstanceType
  - setMaxSessionLengthInMinutes
```
public void setMaxSessionLengthInMinutes(Integer maxSessionLengthInMinutes)
```
    The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    
    Parameters:
    
    maxSessionLengthInMinutes - The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
  - getMaxSessionLengthInMinutes
```
public Integer getMaxSessionLengthInMinutes()
```
    The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    
    Returns:
    
    The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
  - withMaxSessionLengthInMinutes
```
public StreamConfiguration withMaxSessionLengthInMinutes(Integer maxSessionLengthInMinutes)
```
    The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    
    Parameters:
    
    maxSessionLengthInMinutes - The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxStoppedSessionLengthInMinutes
```
public void setMaxStoppedSessionLengthInMinutes(Integer maxStoppedSessionLengthInMinutes)
```
    Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
    
    If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
    
    If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
    
    Parameters:
    
    maxStoppedSessionLengthInMinutes - Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
    
    If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
    
    If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
  - getMaxStoppedSessionLengthInMinutes
```
public Integer getMaxStoppedSessionLengthInMinutes()
```
    Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
    
    If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
    
    If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
    
    Returns:
    
    Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
    
    If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
    
    If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
  - withMaxStoppedSessionLengthInMinutes
```
public StreamConfiguration withMaxStoppedSessionLengthInMinutes(Integer maxStoppedSessionLengthInMinutes)
```
    Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
    
    If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
    
    If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
    
    Parameters:
    
    maxStoppedSessionLengthInMinutes - Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
    
    If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
    
    If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSessionStorage
```
public void setSessionStorage(StreamConfigurationSessionStorage sessionStorage)
```
    (Optional) The upload storage for a streaming session.
    
    Parameters:
    
    sessionStorage - (Optional) The upload storage for a streaming session.
  - getSessionStorage
```
public StreamConfigurationSessionStorage getSessionStorage()
```
    (Optional) The upload storage for a streaming session.
    
    Returns:
    
    (Optional) The upload storage for a streaming session.
  - withSessionStorage
```
public StreamConfiguration withSessionStorage(StreamConfigurationSessionStorage sessionStorage)
```
    (Optional) The upload storage for a streaming session.
    
    Parameters:
    
    sessionStorage - (Optional) The upload storage for a streaming session.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStreamingImageIds
```
public List<String> getStreamingImageIds()
```
    The streaming images that users can select from when launching a streaming session with this launch profile.
    
    Returns:
    
    The streaming images that users can select from when launching a streaming session with this launch profile.
  - setStreamingImageIds
```
public void setStreamingImageIds(Collection<String> streamingImageIds)
```
    The streaming images that users can select from when launching a streaming session with this launch profile.
    
    Parameters:
    
    streamingImageIds - The streaming images that users can select from when launching a streaming session with this launch profile.
  - withStreamingImageIds
```
public StreamConfiguration withStreamingImageIds(String... streamingImageIds)
```
    The streaming images that users can select from when launching a streaming session with this launch profile.
    
    NOTE: This method appends the values to the existing list (if any). Use setStreamingImageIds(java.util.Collection) or withStreamingImageIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    streamingImageIds - The streaming images that users can select from when launching a streaming session with this launch profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStreamingImageIds
```
public StreamConfiguration withStreamingImageIds(Collection<String> streamingImageIds)
```
    The streaming images that users can select from when launching a streaming session with this launch profile.
    
    Parameters:
    
    streamingImageIds - The streaming images that users can select from when launching a streaming session with this launch profile.
    
    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 StreamConfiguration 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 StreamConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StreamConfiguration

Method Detail

setClipboardMode

getClipboardMode

withClipboardMode

withClipboardMode

getEc2InstanceTypes

setEc2InstanceTypes

withEc2InstanceTypes

withEc2InstanceTypes

withEc2InstanceTypes

setMaxSessionLengthInMinutes

getMaxSessionLengthInMinutes

withMaxSessionLengthInMinutes

setMaxStoppedSessionLengthInMinutes

getMaxStoppedSessionLengthInMinutes

withMaxStoppedSessionLengthInMinutes

setSessionStorage

getSessionStorage

withSessionStorage

getStreamingImageIds

setStreamingImageIds

withStreamingImageIds

withStreamingImageIds

toString

equals

hashCode

clone

marshall