Class: Google::Apis::CloudsearchV1::StreamingSessionInfo

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

Information about a streaming session in conference.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ StreamingSessionInfo

Returns a new instance of StreamingSessionInfo.



16209
16210
16211
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16209

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#application_type ⇒ String

The application type of the current streaming session. Corresponds to the JSON property applicationType

Returns:

  • (String) 


16164
16165
16166
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16164

def application_type
  @application_type
end

#latest_session_event ⇒ Google::Apis::CloudsearchV1::SessionEvent

A session event is something that happens to the streaming session in a conference. Corresponds to the JSON property latestSessionEvent

Returns:



16170
16171
16172
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16170

def latest_session_event
  @latest_session_event
end

#owner_display_name ⇒ String

The display name of the owner of the recording output. It's only set when there will be uploaded recordings. Currently, it's only set when application type is RECORDING or GLIVE_STREAM. Corresponds to the JSON property ownerDisplayName

Returns:

  • (String) 


16177
16178
16179
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16177

def owner_display_name
  @owner_display_name
end

#session_id ⇒ String

This is the REST name and unique identifier of this streaming session and has the form spaces//recordings/ This is returned whenever status is either STARTING or STARTED. Corresponds to the JSON property sessionId

Returns:

  • (String) 


16184
16185
16186
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16184

def session_id
  @session_id
end

#status ⇒ String

The current status of this streaming session. This can be used by clients to show session status indicator and/or notification. Corresponds to the JSON property status

Returns:

  • (String) 


16190
16191
16192
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16190

def status
  @status
end

#training_enabled ⇒ Boolean Also known as: training_enabled?

When true, this recording may be used for training new transcription models. Corresponds to the JSON property trainingEnabled

Returns:

  • (Boolean) 


16195
16196
16197
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16195

def training_enabled
  @training_enabled
end

#viewer_access_policy ⇒ String

The policy that controls who can view the broadcast. This setting applies for broadcast session. Corresponds to the JSON property viewerAccessPolicy

Returns:

  • (String) 


16202
16203
16204
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16202

def viewer_access_policy
  @viewer_access_policy
end

#viewer_stats ⇒ Google::Apis::CloudsearchV1::StreamViewerStats

Information about viewers of the stream. Corresponds to the JSON property viewerStats

Returns:



16207
16208
16209
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16207

def viewer_stats
  @viewer_stats
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16214
16215
16216
16217
16218
16219
16220
16221
16222
16223
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16214

def update!(**args)
  @application_type = args[:application_type] if args.key?(:application_type)
  @latest_session_event = args[:latest_session_event] if args.key?(:latest_session_event)
  @owner_display_name = args[:owner_display_name] if args.key?(:owner_display_name)
  @session_id = args[:session_id] if args.key?(:session_id)
  @status = args[:status] if args.key?(:status)
  @training_enabled = args[:training_enabled] if args.key?(:training_enabled)
  @viewer_access_policy = args[:viewer_access_policy] if args.key?(:viewer_access_policy)
  @viewer_stats = args[:viewer_stats] if args.key?(:viewer_stats)
end