Class StreamingSessionStream

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

A stream is an active connection to a streaming session, enabling a studio user to control the streaming session using a compatible client. Streaming session streams are compatible with the NICE DCV web client, included in the Nimble Studio portal, or the NICE DCV desktop client.

See Also:

  • Method Details

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

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

    • expiresAt

      public final Instant expiresAt()

      The ISO timestamp in seconds for when the resource expires.

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

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

    • state

      public final StreamingSessionStreamState state()

      The current state.

      If the service returns an enum value that is not available in the current SDK version, state will return StreamingSessionStreamState.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 StreamingSessionStreamState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state.
      See Also:

    • statusCode

      public final StreamingSessionStreamStatusCode statusCode()

      The streaming session stream status code.

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

      Returns:
      The streaming session stream status code.
      See Also:

    • statusCodeAsString

      public final String statusCodeAsString()

      The streaming session stream status code.

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

      Returns:
      The streaming session stream status code.
      See Also:

    • streamId

      public final String streamId()

      The stream ID.

      Returns:
      The stream ID.

    • url

      public final String url()

      The URL to connect to this stream using the DCV client.

      Returns:
      The URL to connect to this stream using the DCV client.

    • toBuilder

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

    • builder

      public static StreamingSessionStream.Builder builder()

    • serializableBuilderClass

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