Struct StreamingSessionStream

#[non_exhaustive]
pub struct StreamingSessionStream {
    pub created_at: Option<DateTime>,
    pub created_by: Option<String>,
    pub expires_at: Option<DateTime>,
    pub owned_by: Option<String>,
    pub state: Option<StreamingSessionStreamState>,
    pub status_code: Option<StreamingSessionStreamStatusCode>,
    pub stream_id: Option<String>,
    pub url: Option<String>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

created_at: Option<DateTime>

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

created_by: Option<String>

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

expires_at: Option<DateTime>

The ISO timestamp in seconds for when the resource expires.

owned_by: Option<String>

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: Option<StreamingSessionStreamState>

The current state.

status_code: Option<StreamingSessionStreamStatusCode>

The streaming session stream status code.

stream_id: Option<String>

The stream ID.

url: Option<String>

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

Implementations

impl StreamingSessionStream

pub fn created_at(&self) -> Option<&DateTime>

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

pub fn created_by(&self) -> Option<&str>

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

pub fn expires_at(&self) -> Option<&DateTime>

The ISO timestamp in seconds for when the resource expires.

pub fn owned_by(&self) -> Option<&str>

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.

pub fn state(&self) -> Option<&StreamingSessionStreamState>

The current state.

pub fn status_code(&self) -> Option<&StreamingSessionStreamStatusCode>

The streaming session stream status code.

pub fn stream_id(&self) -> Option<&str>

The stream ID.

pub fn url(&self) -> Option<&str>

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

impl StreamingSessionStream

pub fn builder() -> StreamingSessionStreamBuilder

Creates a new builder-style object to manufacture StreamingSessionStream.

Trait Implementations

impl Clone for StreamingSessionStream

fn clone(&self) -> StreamingSessionStream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamingSessionStream

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StreamingSessionStream

fn eq(&self, other: &StreamingSessionStream) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StreamingSessionStream