google-cloud-gaming-v1 0.5.0 → 0.7.0

data/lib/google/cloud/gaming/v1/realms_service/rest/service_stub.rb

@@ -0,0 +1,405 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/gaming/v1/realms_service_pb"
+
+module Google
+  module Cloud
+    module Gaming
+      module V1
+        module RealmsService
+          module Rest
+            ##
+            # REST service stub for the RealmsService service.
+            # Service stub contains baseline method implementations
+            # including transcoding, making the REST call, and deserialing the response.
+            #
+            class ServiceStub
+              def initialize endpoint:, credentials:
+                # These require statements are intentionally placed here to initialize
+                # the REST modules only when it's required.
+                require "gapic/rest"
+
+                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
+                                                             numeric_enums: true,
+                                                             raise_faraday_errors: false
+              end
+
+              ##
+              # Baseline implementation for the list_realms REST call
+              #
+              # @param request_pb [::Google::Cloud::Gaming::V1::ListRealmsRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Gaming::V1::ListRealmsResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Gaming::V1::ListRealmsResponse]
+              #   A result object deserialized from the server's reply
+              def list_realms request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_list_realms_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Gaming::V1::ListRealmsResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the get_realm REST call
+              #
+              # @param request_pb [::Google::Cloud::Gaming::V1::GetRealmRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Gaming::V1::Realm]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Gaming::V1::Realm]
+              #   A result object deserialized from the server's reply
+              def get_realm request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_get_realm_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Gaming::V1::Realm.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the create_realm REST call
+              #
+              # @param request_pb [::Google::Cloud::Gaming::V1::CreateRealmRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Longrunning::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Longrunning::Operation]
+              #   A result object deserialized from the server's reply
+              def create_realm request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_create_realm_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the delete_realm REST call
+              #
+              # @param request_pb [::Google::Cloud::Gaming::V1::DeleteRealmRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Longrunning::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Longrunning::Operation]
+              #   A result object deserialized from the server's reply
+              def delete_realm request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_delete_realm_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the update_realm REST call
+              #
+              # @param request_pb [::Google::Cloud::Gaming::V1::UpdateRealmRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Longrunning::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Longrunning::Operation]
+              #   A result object deserialized from the server's reply
+              def update_realm request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_update_realm_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the preview_realm_update REST call
+              #
+              # @param request_pb [::Google::Cloud::Gaming::V1::PreviewRealmUpdateRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Gaming::V1::PreviewRealmUpdateResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Gaming::V1::PreviewRealmUpdateResponse]
+              #   A result object deserialized from the server's reply
+              def preview_realm_update request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_preview_realm_update_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Gaming::V1::PreviewRealmUpdateResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the list_realms REST call
+              #
+              # @param request_pb [::Google::Cloud::Gaming::V1::ListRealmsRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_list_realms_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{parent}/realms",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the get_realm REST call
+              #
+              # @param request_pb [::Google::Cloud::Gaming::V1::GetRealmRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_get_realm_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{name}",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/realms/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the create_realm REST call
+              #
+              # @param request_pb [::Google::Cloud::Gaming::V1::CreateRealmRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_create_realm_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{parent}/realms",
+                                                          body: "realm",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the delete_realm REST call
+              #
+              # @param request_pb [::Google::Cloud::Gaming::V1::DeleteRealmRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_delete_realm_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :delete,
+                                                          uri_template: "/v1/{name}",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/realms/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the update_realm REST call
+              #
+              # @param request_pb [::Google::Cloud::Gaming::V1::UpdateRealmRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_update_realm_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :patch,
+                                                          uri_template: "/v1/{realm.name}",
+                                                          body: "realm",
+                                                          matches: [
+                                                            ["realm.name", %r{^projects/[^/]+/locations/[^/]+/realms/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the preview_realm_update REST call
+              #
+              # @param request_pb [::Google::Cloud::Gaming::V1::PreviewRealmUpdateRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_preview_realm_update_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :patch,
+                                                          uri_template: "/v1/{realm.name}:previewUpdate",
+                                                          body: "realm",
+                                                          matches: [
+                                                            ["realm.name", %r{^projects/[^/]+/locations/[^/]+/realms/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/gaming/v1/realms_service/rest.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/gaming/v1/version"
+
+require "google/cloud/gaming/v1/realms_service/credentials"
+require "google/cloud/gaming/v1/realms_service/paths"
+require "google/cloud/gaming/v1/realms_service/rest/operations"
+require "google/cloud/gaming/v1/realms_service/rest/client"
+
+module Google
+  module Cloud
+    module Gaming
+      module V1
+        ##
+        # A realm is a grouping of game server clusters that are considered
+        # interchangeable.
+        #
+        # To load this service and instantiate a REST client:
+        #
+        #     require "google/cloud/gaming/v1/realms_service/rest"
+        #     client = ::Google::Cloud::Gaming::V1::RealmsService::Rest::Client.new
+        #
+        module RealmsService
+          # Client for the REST transport
+          module Rest
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/gaming/v1/realms_service/rest/helpers" if ::File.file? helper_path

data/lib/google/cloud/gaming/v1/realms_service.rb

@@ -26,6 +26,7 @@ require "google/cloud/gaming/v1/realms_service/credentials"
 require "google/cloud/gaming/v1/realms_service/paths"
 require "google/cloud/gaming/v1/realms_service/operations"
 require "google/cloud/gaming/v1/realms_service/client"
+require "google/cloud/gaming/v1/realms_service/rest"
 
 module Google
   module Cloud
@@ -35,11 +36,16 @@ module Google
         # A realm is a grouping of game server clusters that are considered
         # interchangeable.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/gaming/v1/realms_service"
         #     client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new
         #
+        # @example Load this service and instantiate a REST client
+        #
+        #     require "google/cloud/gaming/v1/realms_service/rest"
+        #     client = ::Google::Cloud::Gaming::V1::RealmsService::Rest::Client.new
+        #
         module RealmsService
         end
       end

data/lib/google/cloud/gaming/v1/realms_service_pb.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/gaming/v1/realms_service.proto
 
@@ -8,9 +9,31 @@ require 'google/api/client_pb'
 require 'google/cloud/gaming/v1/realms_pb'
 require 'google/longrunning/operations_pb'
 
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("google/cloud/gaming/v1/realms_service.proto", :syntax => :proto3) do
+
+descriptor_data = "\n+google/cloud/gaming/v1/realms_service.proto\x12\x16google.cloud.gaming.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a#google/cloud/gaming/v1/realms.proto\x1a#google/longrunning/operations.proto2\xbb\t\n\rRealmsService\x12\xa0\x01\n\nListRealms\x12).google.cloud.gaming.v1.ListRealmsRequest\x1a*.google.cloud.gaming.v1.ListRealmsResponse\";\x82\xd3\xe4\x93\x02,\x12*/v1/{parent=projects/*/locations/*}/realms\xda\x41\x06parent\x12\x8d\x01\n\x08GetRealm\x12\'.google.cloud.gaming.v1.GetRealmRequest\x1a\x1d.google.cloud.gaming.v1.Realm\"9\x82\xd3\xe4\x93\x02,\x12*/v1/{name=projects/*/locations/*/realms/*}\xda\x41\x04name\x12\xc8\x01\n\x0b\x43reateRealm\x12*.google.cloud.gaming.v1.CreateRealmRequest\x1a\x1d.google.longrunning.Operation\"n\x82\xd3\xe4\x93\x02\x33\"*/v1/{parent=projects/*/locations/*}/realms:\x05realm\xda\x41\x15parent,realm,realm_id\xca\x41\x1a\n\x05Realm\x12\x11OperationMetadata\x12\xc0\x01\n\x0b\x44\x65leteRealm\x12*.google.cloud.gaming.v1.DeleteRealmRequest\x1a\x1d.google.longrunning.Operation\"f\x82\xd3\xe4\x93\x02,**/v1/{name=projects/*/locations/*/realms/*}\xda\x41\x04name\xca\x41*\n\x15google.protobuf.Empty\x12\x11OperationMetadata\x12\xca\x01\n\x0bUpdateRealm\x12*.google.cloud.gaming.v1.UpdateRealmRequest\x1a\x1d.google.longrunning.Operation\"p\x82\xd3\xe4\x93\x02\x39\x32\x30/v1/{realm.name=projects/*/locations/*/realms/*}:\x05realm\xda\x41\x11realm,update_mask\xca\x41\x1a\n\x05Realm\x12\x11OperationMetadata\x12\xca\x01\n\x12PreviewRealmUpdate\x12\x31.google.cloud.gaming.v1.PreviewRealmUpdateRequest\x1a\x32.google.cloud.gaming.v1.PreviewRealmUpdateResponse\"M\x82\xd3\xe4\x93\x02G2>/v1/{realm.name=projects/*/locations/*/realms/*}:previewUpdate:\x05realm\x1aO\xca\x41\x1bgameservices.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformBR\n\x1a\x63om.google.cloud.gaming.v1P\x01Z2cloud.google.com/go/gaming/apiv1/gamingpb;gamingpbb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+
+begin
+  pool.add_serialized_file(descriptor_data)
+rescue TypeError => e
+  # Compatibility code: will be removed in the next major version.
+  require 'google/protobuf/descriptor_pb'
+  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
+  parsed.clear_dependency
+  serialized = parsed.class.encode(parsed)
+  file = pool.add_serialized_file(serialized)
+  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
+  imports = [
+  ]
+  imports.each do |type_name, expected_filename|
+    import_file = pool.lookup(type_name).file_descriptor
+    if import_file.name != expected_filename
+      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
+    end
   end
+  warn "Each proto file must use a consistent fully-qualified name."
+  warn "This will become an error in the next major version."
 end
 
 module Google

data/lib/google/cloud/gaming/v1/rest.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/gaming/v1/game_server_clusters_service/rest"
+require "google/cloud/gaming/v1/game_server_configs_service/rest"
+require "google/cloud/gaming/v1/game_server_deployments_service/rest"
+require "google/cloud/gaming/v1/realms_service/rest"
+require "google/cloud/gaming/v1/version"
+
+module Google
+  module Cloud
+    module Gaming
+      ##
+      # To load just the REST part of this package, including all its services, and instantiate a REST client:
+      #
+      # @example
+      #
+      #     require "google/cloud/gaming/v1/rest"
+      #     client = ::Google::Cloud::Gaming::V1::GameServerClustersService::Rest::Client.new
+      #
+      module V1
+      end
+    end
+  end
+end

data/lib/google/cloud/gaming/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Gaming
       module V1
-        VERSION = "0.5.0"
+        VERSION = "0.7.0"
       end
     end
   end

data/lib/google/cloud/gaming/v1.rb

@@ -26,13 +26,18 @@ module Google
   module Cloud
     module Gaming
       ##
-      # To load this package, including all its services, and instantiate a client:
+      # API client module.
       #
-      # @example
+      # @example Load this package, including all its services, and instantiate a gRPC client
       #
       #     require "google/cloud/gaming/v1"
       #     client = ::Google::Cloud::Gaming::V1::GameServerClustersService::Client.new
       #
+      # @example Load this package, including all its services, and instantiate a REST client
+      #
+      #     require "google/cloud/gaming/v1"
+      #     client = ::Google::Cloud::Gaming::V1::GameServerClustersService::Rest::Client.new
+      #
       module V1
       end
     end