Class: Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/apps/meet/v2/conference_records_service/rest/client.rb

Overview

REST client for the ConferenceRecordsService service.

REST API for services dealing with conference records.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#conference_record_path, #participant_path, #participant_session_path, #recording_path, #transcript_entry_path, #transcript_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new ConferenceRecordsService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ConferenceRecordsService client.

Yield Parameters:



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 186

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @conference_records_service_stub = ::Google::Apps::Meet::V2::ConferenceRecordsService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @conference_records_service_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the ConferenceRecordsService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ConferenceRecordsService clients
::Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Apps", "Meet", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.get_conference_record.timeout = 60.0
    default_config.rpcs.get_conference_record.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_conference_records.timeout = 60.0
    default_config.rpcs.list_conference_records.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_participant.timeout = 60.0
    default_config.rpcs.get_participant.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_participants.timeout = 60.0
    default_config.rpcs.list_participants.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_participant_session.timeout = 60.0
    default_config.rpcs.get_participant_session.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_participant_sessions.timeout = 60.0
    default_config.rpcs.list_participant_sessions.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_recording.timeout = 60.0
    default_config.rpcs.get_recording.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_recordings.timeout = 60.0
    default_config.rpcs.list_recordings.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_transcript.timeout = 60.0
    default_config.rpcs.get_transcript.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_transcripts.timeout = 60.0
    default_config.rpcs.list_transcripts.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_transcript_entry.timeout = 60.0
    default_config.rpcs.get_transcript_entry.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_transcript_entries.timeout = 60.0
    default_config.rpcs.list_transcript_entries.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the ConferenceRecordsService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



156
157
158
159
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 156

def configure
  yield @config if block_given?
  @config
end

#get_conference_record(request, options = nil) ⇒ ::Google::Apps::Meet::V2::ConferenceRecord #get_conference_record(name: nil) ⇒ ::Google::Apps::Meet::V2::ConferenceRecord

Gets a conference record by conference ID.

Examples:

Basic example

require "google/apps/meet/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2::GetConferenceRecordRequest.new

# Call the get_conference_record method.
result = client.get_conference_record request

# The returned object is of type Google::Apps::Meet::V2::ConferenceRecord.
p result

Overloads:

  • #get_conference_record(request, options = nil) ⇒ ::Google::Apps::Meet::V2::ConferenceRecord

    Pass arguments to get_conference_record via a request object, either of type GetConferenceRecordRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Meet::V2::GetConferenceRecordRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_conference_record(name: nil) ⇒ ::Google::Apps::Meet::V2::ConferenceRecord

    Pass arguments to get_conference_record via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the conference.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 282

def get_conference_record request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2::GetConferenceRecordRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_conference_record.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Meet::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_conference_record.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_conference_record.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conference_records_service_stub.get_conference_record request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_participant(request, options = nil) ⇒ ::Google::Apps::Meet::V2::Participant #get_participant(name: nil) ⇒ ::Google::Apps::Meet::V2::Participant

Gets a participant by participant ID.

Examples:

Basic example

require "google/apps/meet/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2::GetParticipantRequest.new

# Call the get_participant method.
result = client.get_participant request

# The returned object is of type Google::Apps::Meet::V2::Participant.
p result

Overloads:

  • #get_participant(request, options = nil) ⇒ ::Google::Apps::Meet::V2::Participant

    Pass arguments to get_participant via a request object, either of type GetParticipantRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Meet::V2::GetParticipantRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_participant(name: nil) ⇒ ::Google::Apps::Meet::V2::Participant

    Pass arguments to get_participant via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the participant.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 461

def get_participant request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2::GetParticipantRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_participant.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Meet::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_participant.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_participant.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conference_records_service_stub.get_participant request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_participant_session(request, options = nil) ⇒ ::Google::Apps::Meet::V2::ParticipantSession #get_participant_session(name: nil) ⇒ ::Google::Apps::Meet::V2::ParticipantSession

Gets a participant session by participant session ID.

Examples:

Basic example

require "google/apps/meet/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2::GetParticipantSessionRequest.new

# Call the get_participant_session method.
result = client.get_participant_session request

# The returned object is of type Google::Apps::Meet::V2::ParticipantSession.
p result

Overloads:

  • #get_participant_session(request, options = nil) ⇒ ::Google::Apps::Meet::V2::ParticipantSession

    Pass arguments to get_participant_session via a request object, either of type GetParticipantSessionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Meet::V2::GetParticipantSessionRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_participant_session(name: nil) ⇒ ::Google::Apps::Meet::V2::ParticipantSession

    Pass arguments to get_participant_session via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the participant.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 645

def get_participant_session request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2::GetParticipantSessionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_participant_session.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Meet::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_participant_session.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_participant_session.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conference_records_service_stub.get_participant_session request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_recording(request, options = nil) ⇒ ::Google::Apps::Meet::V2::Recording #get_recording(name: nil) ⇒ ::Google::Apps::Meet::V2::Recording

Gets a recording by recording ID.

Examples:

Basic example

require "google/apps/meet/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2::GetRecordingRequest.new

# Call the get_recording method.
result = client.get_recording request

# The returned object is of type Google::Apps::Meet::V2::Recording.
p result

Overloads:

  • #get_recording(request, options = nil) ⇒ ::Google::Apps::Meet::V2::Recording

    Pass arguments to get_recording via a request object, either of type GetRecordingRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Meet::V2::GetRecordingRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_recording(name: nil) ⇒ ::Google::Apps::Meet::V2::Recording

    Pass arguments to get_recording via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the recording.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 829

def get_recording request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2::GetRecordingRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_recording.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Meet::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_recording.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_recording.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conference_records_service_stub.get_recording request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_transcript(request, options = nil) ⇒ ::Google::Apps::Meet::V2::Transcript #get_transcript(name: nil) ⇒ ::Google::Apps::Meet::V2::Transcript

Gets a transcript by transcript ID.

Examples:

Basic example

require "google/apps/meet/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2::GetTranscriptRequest.new

# Call the get_transcript method.
result = client.get_transcript request

# The returned object is of type Google::Apps::Meet::V2::Transcript.
p result

Overloads:

  • #get_transcript(request, options = nil) ⇒ ::Google::Apps::Meet::V2::Transcript

    Pass arguments to get_transcript via a request object, either of type GetTranscriptRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Meet::V2::GetTranscriptRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_transcript(name: nil) ⇒ ::Google::Apps::Meet::V2::Transcript

    Pass arguments to get_transcript via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the transcript.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 1000

def get_transcript request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2::GetTranscriptRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_transcript.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Meet::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_transcript.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_transcript.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conference_records_service_stub.get_transcript request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_transcript_entry(request, options = nil) ⇒ ::Google::Apps::Meet::V2::TranscriptEntry #get_transcript_entry(name: nil) ⇒ ::Google::Apps::Meet::V2::TranscriptEntry

Gets a TranscriptEntry resource by entry ID.

Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when the Google Docs transcript file is modified after generation.

Examples:

Basic example

require "google/apps/meet/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2::GetTranscriptEntryRequest.new

# Call the get_transcript_entry method.
result = client.get_transcript_entry request

# The returned object is of type Google::Apps::Meet::V2::TranscriptEntry.
p result

Overloads:

  • #get_transcript_entry(request, options = nil) ⇒ ::Google::Apps::Meet::V2::TranscriptEntry

    Pass arguments to get_transcript_entry via a request object, either of type GetTranscriptEntryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Meet::V2::GetTranscriptEntryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_transcript_entry(name: nil) ⇒ ::Google::Apps::Meet::V2::TranscriptEntry

    Pass arguments to get_transcript_entry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the TranscriptEntry.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 1175

def get_transcript_entry request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2::GetTranscriptEntryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_transcript_entry.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Meet::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_transcript_entry.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_transcript_entry.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conference_records_service_stub.get_transcript_entry request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_conference_records(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::ConferenceRecord> #list_conference_records(page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::ConferenceRecord>

Lists the conference records. By default, ordered by start time and in descending order.

Examples:

Basic example

require "google/apps/meet/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2::ListConferenceRecordsRequest.new

# Call the list_conference_records method.
result = client.list_conference_records request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Apps::Meet::V2::ConferenceRecord.
  p item
end

Overloads:

  • #list_conference_records(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::ConferenceRecord>

    Pass arguments to list_conference_records via a request object, either of type ListConferenceRecordsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Meet::V2::ListConferenceRecordsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_conference_records(page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::ConferenceRecord>

    Pass arguments to list_conference_records via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • page_size (::Integer) (defaults to: nil) —

      Optional. Maximum number of conference records to return. The service might return fewer than this value. If unspecified, at most 25 conference records are returned. The maximum value is 100; values above 100 are coerced to

      1. Maximum might change in the future.
    • page_token (::String) (defaults to: nil) —

      Optional. Page token returned from previous List Call.

    • filter (::String) (defaults to: nil) —

      Optional. User specified filtering condition in EBNF format. The following are the filterable fields:

      • space.meeting_code
      • space.name
      • start_time
      • end_time

      For example, space.meeting_code = "abc-mnop-xyz".

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 381

def list_conference_records request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2::ListConferenceRecordsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_conference_records.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Meet::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_conference_records.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_conference_records.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conference_records_service_stub.list_conference_records request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @conference_records_service_stub, :list_conference_records, "conference_records", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_participant_sessions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::ParticipantSession> #list_participant_sessions(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::ParticipantSession>

Lists the participant sessions of a participant in a conference record. By default, ordered by join time and in descending order. This API supports fields as standard parameters like every other API. However, when the fields request parameter is omitted this API defaults to 'participantsessions/*, next_page_token'.

Examples:

Basic example

require "google/apps/meet/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2::ListParticipantSessionsRequest.new

# Call the list_participant_sessions method.
result = client.list_participant_sessions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Apps::Meet::V2::ParticipantSession.
  p item
end

Overloads:

  • #list_participant_sessions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::ParticipantSession>

    Pass arguments to list_participant_sessions via a request object, either of type ListParticipantSessionsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Meet::V2::ListParticipantSessionsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_participant_sessions(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::ParticipantSession>

    Pass arguments to list_participant_sessions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. Format: conferenceRecords/{conference_record}/participants/{participant}

    • page_size (::Integer) (defaults to: nil) —

      Optional. Maximum number of participant sessions to return. The service might return fewer than this value. If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.

    • page_token (::String) (defaults to: nil) —

      Optional. Page token returned from previous List Call.

    • filter (::String) (defaults to: nil) —

      Optional. User specified filtering condition in EBNF format. The following are the filterable fields:

      • start_time
      • end_time

      For example, end_time IS NULL returns active participant sessions in the conference record.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 749

def list_participant_sessions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2::ListParticipantSessionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_participant_sessions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Meet::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_participant_sessions.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_participant_sessions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conference_records_service_stub.list_participant_sessions request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @conference_records_service_stub, :list_participant_sessions, "participant_sessions", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_participants(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::Participant> #list_participants(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::Participant>

Lists the participants in a conference record. By default, ordered by join time and in descending order. This API supports fields as standard parameters like every other API. However, when the fields request parameter is omitted, this API defaults to 'participants/*, next_page_token'.

Examples:

Basic example

require "google/apps/meet/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2::ListParticipantsRequest.new

# Call the list_participants method.
result = client.list_participants request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Apps::Meet::V2::Participant.
  p item
end

Overloads:

  • #list_participants(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::Participant>

    Pass arguments to list_participants via a request object, either of type ListParticipantsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Meet::V2::ListParticipantsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_participants(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::Participant>

    Pass arguments to list_participants via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. Format: conferenceRecords/{conference_record}

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of participants to return. The service might return fewer than this value. If unspecified, at most 100 participants are returned. The maximum value is 250; values above 250 are coerced to 250. Maximum might change in the future.

    • page_token (::String) (defaults to: nil) —

      Page token returned from previous List Call.

    • filter (::String) (defaults to: nil) —

      Optional. User specified filtering condition in EBNF format. The following are the filterable fields:

      • earliest_start_time
      • latest_end_time

      For example, latest_end_time IS NULL returns active participants in the conference.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 565

def list_participants request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2::ListParticipantsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_participants.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Meet::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_participants.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_participants.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conference_records_service_stub.list_participants request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @conference_records_service_stub, :list_participants, "participants", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_recordings(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::Recording> #list_recordings(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::Recording>

Lists the recording resources from the conference record. By default, ordered by start time and in ascending order.

Examples:

Basic example

require "google/apps/meet/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2::ListRecordingsRequest.new

# Call the list_recordings method.
result = client.list_recordings request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Apps::Meet::V2::Recording.
  p item
end

Overloads:

  • #list_recordings(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::Recording>

    Pass arguments to list_recordings via a request object, either of type ListRecordingsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Meet::V2::ListRecordingsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_recordings(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::Recording>

    Pass arguments to list_recordings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. Format: conferenceRecords/{conference_record}

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of recordings to return. The service might return fewer than this value. If unspecified, at most 10 recordings are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.

    • page_token (::String) (defaults to: nil) —

      Page token returned from previous List Call.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 920

def list_recordings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2::ListRecordingsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_recordings.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Meet::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_recordings.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_recordings.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conference_records_service_stub.list_recordings request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @conference_records_service_stub, :list_recordings, "recordings", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_transcript_entries(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::TranscriptEntry> #list_transcript_entries(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::TranscriptEntry>

Lists the structured transcript entries per transcript. By default, ordered by start time and in ascending order.

Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when the Google Docs transcript file is modified after generation.

Examples:

Basic example

require "google/apps/meet/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2::ListTranscriptEntriesRequest.new

# Call the list_transcript_entries method.
result = client.list_transcript_entries request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Apps::Meet::V2::TranscriptEntry.
  p item
end

Overloads:

  • #list_transcript_entries(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::TranscriptEntry>

    Pass arguments to list_transcript_entries via a request object, either of type ListTranscriptEntriesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Meet::V2::ListTranscriptEntriesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_transcript_entries(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::TranscriptEntry>

    Pass arguments to list_transcript_entries via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. Format: conferenceRecords/{conference_record}/transcripts/{transcript}

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of entries to return. The service might return fewer than this value. If unspecified, at most 10 entries are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.

    • page_token (::String) (defaults to: nil) —

      Page token returned from previous List Call.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 1271

def list_transcript_entries request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2::ListTranscriptEntriesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_transcript_entries.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Meet::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_transcript_entries.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_transcript_entries.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conference_records_service_stub.list_transcript_entries request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @conference_records_service_stub, :list_transcript_entries, "transcript_entries", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_transcripts(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::Transcript> #list_transcripts(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::Transcript>

Lists the set of transcripts from the conference record. By default, ordered by start time and in ascending order.

Examples:

Basic example

require "google/apps/meet/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Meet::V2::ConferenceRecordsService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Meet::V2::ListTranscriptsRequest.new

# Call the list_transcripts method.
result = client.list_transcripts request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Apps::Meet::V2::Transcript.
  p item
end

Overloads:

  • #list_transcripts(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::Transcript>

    Pass arguments to list_transcripts via a request object, either of type ListTranscriptsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Meet::V2::ListTranscriptsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_transcripts(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2::Transcript>

    Pass arguments to list_transcripts via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. Format: conferenceRecords/{conference_record}

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of transcripts to return. The service might return fewer than this value. If unspecified, at most 10 transcripts are returned. The maximum value is 100; values above 100 are coerced to 100. Maximum might change in the future.

    • page_token (::String) (defaults to: nil) —

      Page token returned from previous List Call.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 1091

def list_transcripts request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Meet::V2::ListTranscriptsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_transcripts.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Meet::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_transcripts.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_transcripts.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @conference_records_service_stub.list_transcripts request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @conference_records_service_stub, :list_transcripts, "transcripts", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


233
234
235
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 233

def logger
  @conference_records_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


166
167
168
 
# File 'lib/google/apps/meet/v2/conference_records_service/rest/client.rb', line 166

def universe_domain
  @conference_records_service_stub.universe_domain
end