google-apps-meet-v2beta 0.3.2 → 0.5.0

data/lib/google/apps/meet/v2beta/conference_records_service/rest/client.rb

@@ -210,14 +210,33 @@ module Google
                   endpoint: @config.endpoint,
                   endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                   universe_domain: @config.universe_domain,
-                  credentials: credentials
+                  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
+
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger
+                @conference_records_service_stub.logger
               end
 
               # Service calls
 
               ##
-              # [Developer Preview](https://developers.google.com/workspace/preview).
               # Gets a conference record by conference ID.
               #
               # @overload get_conference_record(request, options = nil)
@@ -290,15 +309,14 @@ module Google
 
                 @conference_records_service_stub.get_conference_record request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # [Developer Preview](https://developers.google.com/workspace/preview).
-              # Lists the conference records by start time and in descending order.
+              # Lists the conference records. By default, ordered by start time and in
+              # descending order.
               #
               # @overload list_conference_records(request, options = nil)
               #   Pass arguments to `list_conference_records` via a request object, either of type
@@ -323,15 +341,22 @@ module Google
               #   @param page_token [::String]
               #     Optional. Page token returned from previous List Call.
               #   @param filter [::String]
-              #     Optional. User specified filtering condition in EBNF format. The following
-              #     are the filterable fields:
+              #     Optional. User specified filtering condition in [EBNF
+              #     format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form).
+              #     The following are the filterable fields:
               #
               #     * `space.meeting_code`
               #     * `space.name`
               #     * `start_time`
               #     * `end_time`
               #
-              #     For example, `space.meeting_code = "abc-mnop-xyz"`.
+              #     For example, consider the following filters:
+              #
+              #     * `space.name = "spaces/NAME"`
+              #     * `space.meeting_code = "abc-mnop-xyz"`
+              #     * `start_time>="2024-01-01T00:00:00.000Z" AND
+              #     start_time<="2024-01-02T00:00:00.000Z"`
+              #     * `end_time IS NULL`
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Apps::Meet::V2beta::ConferenceRecord>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -390,14 +415,13 @@ module Google
                 @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?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # [Developer Preview](https://developers.google.com/workspace/preview).
               # Gets a participant by participant ID.
               #
               # @overload get_participant(request, options = nil)
@@ -470,15 +494,13 @@ module Google
 
                 @conference_records_service_stub.get_participant request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # [Developer Preview](https://developers.google.com/workspace/preview).
-              # Lists the participants in a conference record, by default ordered by join
+              # 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/*,
@@ -510,8 +532,9 @@ module Google
               #   @param page_token [::String]
               #     Page token returned from previous List Call.
               #   @param filter [::String]
-              #     Optional. User specified filtering condition in EBNF format. The following
-              #     are the filterable fields:
+              #     Optional. User specified filtering condition in [EBNF
+              #     format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form).
+              #     The following are the filterable fields:
               #
               #     * `earliest_start_time`
               #     * `latest_end_time`
@@ -576,14 +599,13 @@ module Google
                 @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?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # [Developer Preview](https://developers.google.com/workspace/preview).
               # Gets a participant session by participant session ID.
               #
               # @overload get_participant_session(request, options = nil)
@@ -656,16 +678,14 @@ module Google
 
                 @conference_records_service_stub.get_participant_session request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # [Developer Preview](https://developers.google.com/workspace/preview).
-              # Lists the participant sessions of a participant in a conference record, by
-              # default ordered by join time and in descending order. This API supports
+              # 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'`.
@@ -696,8 +716,9 @@ module Google
               #   @param page_token [::String]
               #     Optional. Page token returned from previous List Call.
               #   @param filter [::String]
-              #     Optional. User specified filtering condition in EBNF format. The following
-              #     are the filterable fields:
+              #     Optional. User specified filtering condition in [EBNF
+              #     format](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form).
+              #     The following are the filterable fields:
               #
               #     * `start_time`
               #     * `end_time`
@@ -762,14 +783,13 @@ module Google
                 @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?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # [Developer Preview](https://developers.google.com/workspace/preview).
               # Gets a recording by recording ID.
               #
               # @overload get_recording(request, options = nil)
@@ -842,15 +862,14 @@ module Google
 
                 @conference_records_service_stub.get_recording request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # [Developer Preview](https://developers.google.com/workspace/preview).
-              # Lists the recording resources from the conference record.
+              # Lists the recording resources from the conference record. By default,
+              # ordered by start time and in ascending order.
               #
               # @overload list_recordings(request, options = nil)
               #   Pass arguments to `list_recordings` via a request object, either of type
@@ -935,14 +954,13 @@ module Google
                 @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?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # [Developer Preview](https://developers.google.com/workspace/preview).
               # Gets a transcript by transcript ID.
               #
               # @overload get_transcript(request, options = nil)
@@ -1015,15 +1033,14 @@ module Google
 
                 @conference_records_service_stub.get_transcript request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # [Developer Preview](https://developers.google.com/workspace/preview).
-              # Lists the set of transcripts from the conference record.
+              # Lists the set of transcripts from the conference record. By default,
+              # ordered by start time and in ascending order.
               #
               # @overload list_transcripts(request, options = nil)
               #   Pass arguments to `list_transcripts` via a request object, either of type
@@ -1108,14 +1125,13 @@ module Google
                 @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?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # [Developer Preview](https://developers.google.com/workspace/preview).
               # Gets a `TranscriptEntry` resource by entry ID.
               #
               # Note: The transcript entries returned by the Google Meet API might not
@@ -1192,14 +1208,12 @@ module Google
 
                 @conference_records_service_stub.get_transcript_entry request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # [Developer Preview](https://developers.google.com/workspace/preview).
               # Lists the structured transcript entries per transcript. By default, ordered
               # by start time and in ascending order.
               #
@@ -1291,7 +1305,7 @@ module Google
                 @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?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1339,6 +1353,13 @@ module Google
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
               #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`nil`) indicating no credentials
+              #
+              #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+              #   external source for authentication to Google Cloud, you must validate it before
+              #   providing it to a Google API client library. Providing an unvalidated credential
+              #   configuration to Google APIs can compromise the security of your systems and data.
+              #   For more information, refer to [Validate credential configurations from external
+              #   sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
               #   @return [::Object]
               # @!attribute [rw] scope
               #   The OAuth scopes
@@ -1371,6 +1392,11 @@ module Google
               #   default endpoint URL. The default value of nil uses the environment
               #   universe (usually the default "googleapis.com" universe).
               #   @return [::String,nil]
+              # @!attribute [rw] logger
+              #   A custom logger to use for request/response debug logging, or the value
+              #   `:default` (the default) to construct a default logger, or `nil` to
+              #   explicitly disable logging.
+              #   @return [::Logger,:default,nil]
               #
               class Configuration
                 extend ::Gapic::Config
@@ -1392,6 +1418,7 @@ module Google
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
                 config_attr :universe_domain, nil, ::String, nil
+                config_attr :logger, :default, ::Logger, nil, :default
 
                 # @private
                 def initialize parent_config = nil

data/lib/google/apps/meet/v2beta/conference_records_service/rest/service_stub.rb

@@ -30,7 +30,8 @@ module Google
             # including transcoding, making the REST call, and deserialing the response.
             #
             class ServiceStub
-              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
+              # @private
+              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
                 # These require statements are intentionally placed here to initialize
                 # the REST modules only when it's required.
                 require "gapic/rest"
@@ -40,7 +41,9 @@ module Google
                                                              universe_domain: universe_domain,
                                                              credentials: credentials,
                                                              numeric_enums: true,
-                                                             raise_faraday_errors: false
+                                                             service_name: self.class,
+                                                             raise_faraday_errors: false,
+                                                             logger: logger
               end
 
               ##
@@ -61,6 +64,15 @@ module Google
                 @client_stub.endpoint
               end
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger stub: false
+                stub ? @client_stub.stub_logger : @client_stub.logger
+              end
+
               ##
               # Baseline implementation for the get_conference_record REST call
               #
@@ -87,16 +99,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_conference_record",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Apps::Meet::V2beta::ConferenceRecord.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -125,16 +139,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_conference_records",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Apps::Meet::V2beta::ListConferenceRecordsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -163,16 +179,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_participant",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Apps::Meet::V2beta::Participant.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -201,16 +219,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_participants",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Apps::Meet::V2beta::ListParticipantsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -239,16 +259,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_participant_session",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Apps::Meet::V2beta::ParticipantSession.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -277,16 +299,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_participant_sessions",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Apps::Meet::V2beta::ListParticipantSessionsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -315,16 +339,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_recording",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Apps::Meet::V2beta::Recording.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -353,16 +379,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_recordings",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Apps::Meet::V2beta::ListRecordingsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -391,16 +419,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_transcript",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Apps::Meet::V2beta::Transcript.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -429,16 +459,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_transcripts",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Apps::Meet::V2beta::ListTranscriptsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -467,16 +499,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_transcript_entry",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Apps::Meet::V2beta::TranscriptEntry.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -505,16 +539,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_transcript_entries",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Apps::Meet::V2beta::ListTranscriptEntriesResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##