Class StreamingSession

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

A streaming session is a virtual workstation created using a particular launch profile.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

      Returns:
      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

    • 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:

    • backupMode

      public final SessionBackupMode backupMode()

      Shows the current backup setting of the session.

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

      Returns:
      Shows the current backup setting of the session.
      See Also:

    • backupModeAsString

      public final String backupModeAsString()

      Shows the current backup setting of the session.

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

      Returns:
      Shows the current backup setting of the session.
      See Also:

    • createdAt

      public final Instant createdAt()

      The ISO timestamp in seconds for when the resource was created.

      Returns:
      The ISO timestamp in seconds for when the resource was created.

    • createdBy

      public final String createdBy()

      The user ID of the user that created the streaming session.

      Returns:
      The user ID of the user that created the streaming session.

    • ec2InstanceType

      public final String ec2InstanceType()

      The EC2 Instance type used for the streaming session.

      Returns:
      The EC2 Instance type used for the streaming session.

    • launchProfileId

      public final String launchProfileId()

      The ID of the launch profile used to control access from the streaming session.

      Returns:
      The ID of the launch profile used to control access from the streaming session.

    • maxBackupsToRetain

      public final Integer maxBackupsToRetain()

      The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

      Returns:
      The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

    • ownedBy

      public final String ownedBy()

      The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

      Returns:
      The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

    • sessionId

      public final String sessionId()

      The session ID.

      Returns:
      The session ID.

    • 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:

    • startedAt

      public final Instant startedAt()

      The time the session entered START_IN_PROGRESS state.

      Returns:
      The time the session entered START_IN_PROGRESS state.

    • startedBy

      public final String startedBy()

      The user ID of the user that started the streaming session.

      Returns:
      The user ID of the user that started the streaming session.

    • startedFromBackupId

      public final String startedFromBackupId()

      The backup ID used to restore a streaming session.

      Returns:
      The backup ID used to restore a streaming session.

    • state

      public final StreamingSessionState state()

      The current state.

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

      Returns:
      The current state.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state.

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

      Returns:
      The current state.
      See Also:

    • statusCode

      public final StreamingSessionStatusCode statusCode()

      The status code.

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

      Returns:
      The status code.
      See Also:

    • statusCodeAsString

      public final String statusCodeAsString()

      The status code.

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

      Returns:
      The status code.
      See Also:

    • statusMessage

      public final String statusMessage()

      The status message for the streaming session.

      Returns:
      The status message for the streaming session.

    • stopAt

      public final Instant stopAt()

      The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

      Returns:
      The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

    • stoppedAt

      public final Instant stoppedAt()

      The time the session entered STOP_IN_PROGRESS state.

      Returns:
      The time the session entered STOP_IN_PROGRESS state.

    • stoppedBy

      public final String stoppedBy()

      The user ID of the user that stopped the streaming session.

      Returns:
      The user ID of the user that stopped the streaming session.

    • streamingImageId

      public final String streamingImageId()

      The ID of the streaming image.

      Returns:
      The ID of the streaming image.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      A collection of labels, in the form of key-value pairs, that apply to this resource.

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

      Returns:
      A collection of labels, in the form of key-value pairs, that apply to this resource.

    • terminateAt

      public final Instant terminateAt()

      The time the streaming session will automatically terminate if not terminated by the user.

      Returns:
      The time the streaming session will automatically terminate if not terminated by the user.

    • updatedAt

      public final Instant updatedAt()

      The ISO timestamp in seconds for when the resource was updated.

      Returns:
      The ISO timestamp in seconds for when the resource was updated.

    • updatedBy

      public final String updatedBy()

      The user ID of the user that most recently updated the resource.

      Returns:
      The user ID of the user that most recently updated the resource.

    • 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.

    • volumeRetentionMode

      public final VolumeRetentionMode volumeRetentionMode()

      Determine if an EBS volume created from this streaming session will be backed up.

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

      Returns:
      Determine if an EBS volume created from this streaming session will be backed up.
      See Also:

    • volumeRetentionModeAsString

      public final String volumeRetentionModeAsString()

      Determine if an EBS volume created from this streaming session will be backed up.

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

      Returns:
      Determine if an EBS volume created from this streaming session will be backed up.
      See Also:

    • toBuilder

      public StreamingSession.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<StreamingSession.Builder,StreamingSession>
      Returns:
      a builder for type T

    • builder

      public static StreamingSession.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StreamingSession.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.