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

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

Overview

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 client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the ConferenceRecordsService client.

Yield Parameters:



184
185
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
227
228
229
230
231
232
233
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 184

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/apps/meet/v2/service_services_pb"

  # 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 = ::Gapic::ServiceStub.new(
    ::Google::Apps::Meet::V2::ConferenceRecordsService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @conference_records_service_stub.stub_logger&.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::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



62
63
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
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 62

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:



154
155
156
157
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 154

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

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 290

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
  metadata = @config.rpcs.get_conference_record.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_conference_record.timeout,
                         metadata:     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.call_rpc :get_conference_record, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 475

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
  metadata = @config.rpcs.get_participant.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_participant.timeout,
                         metadata:     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.call_rpc :get_participant, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 673

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
  metadata = @config.rpcs.get_participant_session.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_participant_session.timeout,
                         metadata:     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.call_rpc :get_participant_session, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 871

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
  metadata = @config.rpcs.get_recording.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_recording.timeout,
                         metadata:     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.call_rpc :get_recording, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 1056

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
  metadata = @config.rpcs.get_transcript.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_transcript.timeout,
                         metadata:     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.call_rpc :get_transcript, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 1245

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
  metadata = @config.rpcs.get_transcript_entry.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_transcript_entry.timeout,
                         metadata:     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.call_rpc :get_transcript_entry, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_conference_records(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Apps::Meet::V2::ConferenceRecord> #list_conference_records(page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::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::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::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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 396

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
  metadata = @config.rpcs.list_conference_records.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_conference_records.timeout,
                         metadata:     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.call_rpc :list_conference_records, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @conference_records_service_stub, :list_conference_records, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_participant_sessions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Apps::Meet::V2::ParticipantSession> #list_participant_sessions(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::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::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::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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 784

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
  metadata = @config.rpcs.list_participant_sessions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_participant_sessions.timeout,
                         metadata:     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.call_rpc :list_participant_sessions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @conference_records_service_stub, :list_participant_sessions, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_participants(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Apps::Meet::V2::Participant> #list_participants(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::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::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::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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 586

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
  metadata = @config.rpcs.list_participants.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_participants.timeout,
                         metadata:     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.call_rpc :list_participants, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @conference_records_service_stub, :list_participants, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_recordings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Apps::Meet::V2::Recording> #list_recordings(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::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::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::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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 969

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
  metadata = @config.rpcs.list_recordings.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_recordings.timeout,
                         metadata:     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.call_rpc :list_recordings, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @conference_records_service_stub, :list_recordings, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_transcript_entries(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Apps::Meet::V2::TranscriptEntry> #list_transcript_entries(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::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::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::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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 1348

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
  metadata = @config.rpcs.list_transcript_entries.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_transcript_entries.timeout,
                         metadata:     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.call_rpc :list_transcript_entries, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @conference_records_service_stub, :list_transcript_entries, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_transcripts(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Apps::Meet::V2::Transcript> #list_transcripts(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::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::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::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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 1154

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
  metadata = @config.rpcs.list_transcripts.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_transcripts.timeout,
                         metadata:     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.call_rpc :list_transcripts, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @conference_records_service_stub, :list_transcripts, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


240
241
242
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 240

def logger
  @conference_records_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


164
165
166
 
# File 'lib/google/apps/meet/v2/conference_records_service/client.rb', line 164

def universe_domain
  @conference_records_service_stub.universe_domain
end