Class StreamingSessionStream
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The ISO timestamp in seconds for when the resource was created.final String
The user ID of the user that created the streaming session stream.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Instant
The ISO timestamp in seconds for when the resource expires.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
ownedBy()
The user ID of the user that owns the streaming session.static Class
<? extends StreamingSessionStream.Builder> state()
The current state.final String
The current state.The streaming session stream status code.final String
The streaming session stream status code.final String
streamId()
The stream ID.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
url()
The URL to connect to this stream using the DCV client.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The ISO timestamp in seconds for when the resource expires.
- Returns:
- The ISO timestamp in seconds for when the resource expires.
-
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
The current state.
If the service returns an enum value that is not available in the current SDK version,
state
will returnStreamingSessionStreamState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state.
- See Also:
-
stateAsString
The current state.
If the service returns an enum value that is not available in the current SDK version,
state
will returnStreamingSessionStreamState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state.
- See Also:
-
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 returnStreamingSessionStreamStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The streaming session stream status code.
- See Also:
-
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 returnStreamingSessionStreamStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The streaming session stream status code.
- See Also:
-
streamId
The stream ID.
- Returns:
- The stream ID.
-
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
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 interfaceToCopyableBuilder<StreamingSessionStream.Builder,
StreamingSessionStream> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-