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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreamingSessionStream.Builder

Method Summary

Modifier and Type	Method	Description
static StreamingSessionStream.Builder	builder()
Instant	createdAt()	The ISO timestamp in seconds for when the resource was created.
String	createdBy()	The user ID of the user that created the streaming session stream.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	expiresAt()	The ISO timestamp in seconds for when the resource expires.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	ownedBy()	The user ID of the user that owns the streaming session.
List<SdkField<?>>	sdkFields()
static Class<? extends StreamingSessionStream.Builder>	serializableBuilderClass()
StreamingSessionStreamState	state()	The current state.
String	stateAsString()	The current state.
StreamingSessionStreamStatusCode	statusCode()	The streaming session stream status code.
String	statusCodeAsString()	The streaming session stream status code.
String	streamId()	The stream ID.
StreamingSessionStream.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	url()	The URL to connect to this stream using the DCV client.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

StreamingSessionStreamState

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:

StreamingSessionStreamState

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:

StreamingSessionStreamStatusCode

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:

StreamingSessionStreamStatusCode

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()

Specified by:

toBuilder in interface ToCopyableBuilder<StreamingSessionStream.Builder,StreamingSessionStream>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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