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.



19674
19675
19676
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19674

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) 


19629
19630
19631
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19629

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:



19635
19636
19637
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19635

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) 


19642
19643
19644
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19642

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) 


19649
19650
19651
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19649

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) 


19655
19656
19657
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19655

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) 


19660
19661
19662
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19660

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) 


19667
19668
19669
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19667

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:



19672
19673
19674
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19672

def viewer_stats
  @viewer_stats
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19679
19680
19681
19682
19683
19684
19685
19686
19687
19688
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19679

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