Package software.amazon.awssdk.services.nimble.model

Class StreamConfiguration

java.lang.Object
software.amazon.awssdk.services.nimble.model.StreamConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<StreamConfiguration.Builder,StreamConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class StreamConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StreamConfiguration.Builder,StreamConfiguration>

A configuration for a streaming session.

See Also:

  • Method Details

    • automaticTerminationMode

      public final AutomaticTerminationMode automaticTerminationMode()

      Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

      • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

      • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

      This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

      If the service returns an enum value that is not available in the current SDK version, automaticTerminationMode will return AutomaticTerminationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automaticTerminationModeAsString().

      Returns:
      Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

      • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

      • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

      This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

      See Also:

    • automaticTerminationModeAsString

      public final String automaticTerminationModeAsString()

      Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

      • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

      • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

      This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

      If the service returns an enum value that is not available in the current SDK version, automaticTerminationMode will return AutomaticTerminationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automaticTerminationModeAsString().

      Returns:
      Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

      • When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

      • When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

      This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

      See Also:

    • clipboardMode

      public final StreamingClipboardMode clipboardMode()

      Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

      If the service returns an enum value that is not available in the current SDK version, clipboardMode will return StreamingClipboardMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clipboardModeAsString().

      Returns:
      Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
      See Also:

    • clipboardModeAsString

      public final String clipboardModeAsString()

      Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

      If the service returns an enum value that is not available in the current SDK version, clipboardMode will return StreamingClipboardMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clipboardModeAsString().

      Returns:
      Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
      See Also:

    • ec2InstanceTypes

      public final List<StreamingInstanceType> ec2InstanceTypes()

      The EC2 instance types that users can select from when launching a streaming session with this launch profile.

      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 hasEc2InstanceTypes() method.

      Returns:
      The EC2 instance types that users can select from when launching a streaming session with this launch profile.

    • hasEc2InstanceTypes

      public final boolean hasEc2InstanceTypes()
      For responses, this returns true if the service returned a value for the Ec2InstanceTypes 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.

    • ec2InstanceTypesAsStrings

      public final List<String> ec2InstanceTypesAsStrings()

      The EC2 instance types that users can select from when launching a streaming session with this launch profile.

      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 hasEc2InstanceTypes() method.

      Returns:
      The EC2 instance types that users can select from when launching a streaming session with this launch profile.

    • maxSessionLengthInMinutes

      public final 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.

      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.

    • maxStoppedSessionLengthInMinutes

      public final 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.

      This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

      If the value is 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 (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 (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.

      This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

      If the value is 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 (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 (instead of terminated).

    • sessionBackup

      public final StreamConfigurationSessionBackup sessionBackup()

      Information about the streaming session backup.

      Returns:
      Information about the streaming session backup.

    • sessionPersistenceMode

      public final SessionPersistenceMode sessionPersistenceMode()

      Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

      If the service returns an enum value that is not available in the current SDK version, sessionPersistenceMode will return SessionPersistenceMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sessionPersistenceModeAsString().

      Returns:
      Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
      See Also:

    • sessionPersistenceModeAsString

      public final String sessionPersistenceModeAsString()

      Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

      If the service returns an enum value that is not available in the current SDK version, sessionPersistenceMode will return SessionPersistenceMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sessionPersistenceModeAsString().

      Returns:
      Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
      See Also:

    • sessionStorage

      public final StreamConfigurationSessionStorage sessionStorage()

      The upload storage for a streaming session.

      Returns:
      The upload storage for a streaming session.

    • hasStreamingImageIds

      public final boolean hasStreamingImageIds()
      For responses, this returns true if the service returned a value for the StreamingImageIds 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.

    • streamingImageIds

      public final List<String> streamingImageIds()

      The streaming images that users can select from when launching a streaming session with this launch profile.

      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 hasStreamingImageIds() method.

      Returns:
      The streaming images that users can select from when launching a streaming session with this launch profile.

    • volumeConfiguration

      public final VolumeConfiguration volumeConfiguration()

      Custom volume configuration for the root volumes that are attached to streaming sessions.

      This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

      Returns:
      Custom volume configuration for the root volumes that are attached to streaming sessions.

      This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

    • toBuilder

      public StreamConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StreamConfiguration.Builder,StreamConfiguration>
      Returns:
      a builder for type T

    • builder

      public static StreamConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StreamConfiguration.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.