google-apps-meet-v2beta 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c77ed68097f06b5f74fdef641cf723b403809f334433da90c1c528ffb080d9ee
-  data.tar.gz: baf1ddc568d5b49ad97c41ab53bd484b8a3fab3806fd6436af99b2fb623bd375
+  metadata.gz: d4e1fd4497630774c182a916d76b249b113e438dffaa296bfbc23a1742a7612f
+  data.tar.gz: a99423b3da8ad1861d3e831eff7f2587f25eaa7fada359117f0308dbd96e7637
 SHA512:
-  metadata.gz: 7ba8c0654afa11c737052c42788311db6f6c4128acafd9d023eaf8ccba91454fe2d85a7ed2a8e822d3a07b334051bc58a6e877e3445257d5c773271e84d8c2ed
-  data.tar.gz: 913ba078d8ea52050a01ef2708f0cb617ee32c71e97df7c70f43b8cacf990fe0ab29cc1b98239326d7a62bc427212b226f815feb24635d06657f9b10dc8f4723
+  metadata.gz: 0e96180eb0e0380a33cfecd8e55f391113c1afa6e867df09828d4a5c0648b548b04434cd9524318c0ac825a30ad23f0f4bc3456cbd545b77af55577c219e8f22
+  data.tar.gz: 6ba6e16b2b2f2afbd80bd27b64f2a8a17a2d4441ab44d11436556b01833934614d1dd6235b6175b4ec0319a8102e5781d1ebfd96bb46f61d1e5d37f66b8b05b5

data/README.md

@@ -42,40 +42,50 @@ for class and method documentation.
 See also the [Product Documentation](https://developers.google.com/meet/api/guides/overview)
 for general usage information.
 
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
-that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+You can customize logging by modifying the `logger` configuration when
+constructing a client object. For example:
 
 ```ruby
+require "google/apps/meet/v2beta"
 require "logger"
 
-module MyLogger
-  LOGGER = Logger.new $stderr, level: Logger::WARN
-  def logger
-    LOGGER
-  end
-end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
-  extend MyLogger
+client = ::Google::Apps::Meet::V2beta::SpacesService::Client.new do |config|
+  config.logger = Logger.new "my-app.log"
 end
 ```
 
-
 ## Google Cloud Samples
 
 To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

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

@@ -217,14 +217,33 @@ module Google
                 universe_domain: @config.universe_domain,
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors,
-                channel_pool_config: @config.channel_pool
+                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
+
+            ##
+            # 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)
@@ -304,15 +323,14 @@ module Google
 
               @conference_records_service_stub.call_rpc :get_conference_record, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => 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
@@ -337,15 +355,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 [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Apps::Meet::V2beta::ConferenceRecord>]
@@ -403,14 +428,13 @@ module Google
               @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?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => 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)
@@ -490,15 +514,13 @@ module Google
 
               @conference_records_service_stub.call_rpc :get_participant, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => 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/*,
@@ -530,8 +552,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`
@@ -603,14 +626,13 @@ module Google
               @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?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => 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)
@@ -690,16 +712,14 @@ module Google
 
               @conference_records_service_stub.call_rpc :get_participant_session, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => 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'`.
@@ -730,8 +750,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`
@@ -803,14 +824,13 @@ module Google
               @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?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => 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)
@@ -890,15 +910,14 @@ module Google
 
               @conference_records_service_stub.call_rpc :get_recording, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => 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
@@ -990,14 +1009,13 @@ module Google
               @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?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => 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)
@@ -1077,15 +1095,14 @@ module Google
 
               @conference_records_service_stub.call_rpc :get_transcript, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => 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
@@ -1177,14 +1194,13 @@ module Google
               @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?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => 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
@@ -1268,14 +1284,12 @@ module Google
 
               @conference_records_service_stub.call_rpc :get_transcript_entry, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => 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.
             #
@@ -1374,7 +1388,7 @@ module Google
               @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?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1424,6 +1438,13 @@ module Google
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`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
@@ -1463,6 +1484,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
@@ -1487,6 +1513,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/credentials.rb

@@ -25,6 +25,10 @@ module Google
         module ConferenceRecordsService
           # Credentials for the ConferenceRecordsService API.
           class Credentials < ::Google::Auth::Credentials
+            self.scope = [
+              "https://www.googleapis.com/auth/meetings.space.created",
+              "https://www.googleapis.com/auth/meetings.space.readonly"
+            ]
             self.env_vars = [
               "GOOGLE_CLOUD_CREDENTIALS",
               "GOOGLE_CLOUD_KEYFILE",