google-cloud-gaming-v1 0.3.2 → 0.4.2

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

@@ -42,13 +42,12 @@ module Google
             # See {::Google::Cloud::Gaming::V1::RealmsService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all RealmsService clients:
-            #
-            #     ::Google::Cloud::Gaming::V1::RealmsService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all RealmsService clients
+            #   ::Google::Cloud::Gaming::V1::RealmsService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -116,19 +115,15 @@ module Google
             ##
             # Create a new RealmsService client object.
             #
-            # ## Examples
-            #
-            # To create a new RealmsService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new
             #
-            # To create a new RealmsService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the RealmsService client.
             # @yieldparam config [Client::Configuration]
@@ -148,10 +143,9 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # 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.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
@@ -203,7 +197,7 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The parent resource name. Uses the form:
+            #     Required. The parent resource name, in the following form:
             #     `projects/{project}/locations/{location}`.
             #   @param page_size [::Integer]
             #     Optional. The maximum number of items to return.  If unspecified, server
@@ -228,6 +222,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/gaming/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Gaming::V1::RealmsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Gaming::V1::ListRealmsRequest.new
+            #
+            #   # Call the list_realms method.
+            #   result = client.list_realms request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Gaming::V1::Realm.
+            #     p response
+            #   end
+            #
             def list_realms request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -245,16 +260,20 @@ module Google
                 gapic_version: ::Google::Cloud::Gaming::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              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_realms.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_realms.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @realms_service_stub.call_rpc :list_realms, request, options: options do |response, operation|
@@ -285,7 +304,7 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The name of the realm to retrieve. Uses the form:
+            #     Required. The name of the realm to retrieve, in the following form:
             #     `projects/{project}/locations/{location}/realms/{realm}`.
             #
             # @yield [response, operation] Access the result along with the RPC operation
@@ -296,6 +315,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/gaming/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Gaming::V1::RealmsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Gaming::V1::GetRealmRequest.new
+            #
+            #   # Call the get_realm method.
+            #   result = client.get_realm request
+            #
+            #   # The returned object is of type Google::Cloud::Gaming::V1::Realm.
+            #   p result
+            #
             def get_realm request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -313,16 +347,20 @@ module Google
                 gapic_version: ::Google::Cloud::Gaming::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              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_realm.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_realm.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @realms_service_stub.call_rpc :get_realm, request, options: options do |response, operation|
@@ -352,7 +390,7 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The parent resource name. Uses the form:
+            #     Required. The parent resource name, in the following form:
             #     `projects/{project}/locations/{location}`.
             #   @param realm_id [::String]
             #     Required. The ID of the realm resource to be created.
@@ -367,6 +405,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/gaming/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Gaming::V1::RealmsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Gaming::V1::CreateRealmRequest.new
+            #
+            #   # Call the create_realm method.
+            #   result = client.create_realm request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def create_realm request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -384,16 +444,20 @@ module Google
                 gapic_version: ::Google::Cloud::Gaming::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              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.create_realm.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_realm.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @realms_service_stub.call_rpc :create_realm, request, options: options do |response, operation|
@@ -424,7 +488,7 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The name of the realm to delete. Uses the form:
+            #     Required. The name of the realm to delete, in the following form:
             #     `projects/{project}/locations/{location}/realms/{realm}`.
             #
             # @yield [response, operation] Access the result along with the RPC operation
@@ -435,6 +499,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/gaming/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Gaming::V1::RealmsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Gaming::V1::DeleteRealmRequest.new
+            #
+            #   # Call the delete_realm method.
+            #   result = client.delete_realm request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def delete_realm request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -452,16 +538,20 @@ module Google
                 gapic_version: ::Google::Cloud::Gaming::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              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.delete_realm.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_realm.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @realms_service_stub.call_rpc :delete_realm, request, options: options do |response, operation|
@@ -497,10 +587,7 @@ module Google
             #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
             #     Required. The update mask applies to the resource. For the `FieldMask`
             #     definition, see
-            #
-            #     https:
-            #     //developers.google.com/protocol-buffers
-            #     // /docs/reference/google.protobuf#fieldmask
+            #     https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -510,6 +597,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/gaming/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Gaming::V1::RealmsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Gaming::V1::UpdateRealmRequest.new
+            #
+            #   # Call the update_realm method.
+            #   result = client.update_realm request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def update_realm request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -527,16 +636,20 @@ module Google
                 gapic_version: ::Google::Cloud::Gaming::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "realm.name" => request.realm.name
-              }
+              header_params = {}
+              if request.realm&.name
+                header_params["realm.name"] = request.realm.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.update_realm.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_realm.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @realms_service_stub.call_rpc :update_realm, request, options: options do |response, operation|
@@ -572,10 +685,7 @@ module Google
             #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
             #     Required. The update mask applies to the resource. For the `FieldMask`
             #     definition, see
-            #
-            #     https:
-            #     //developers.google.com/protocol-buffers
-            #     // /docs/reference/google.protobuf#fieldmask
+            #     https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
             #   @param preview_time [::Google::Protobuf::Timestamp, ::Hash]
             #     Optional. The target timestamp to compute the preview.
             #
@@ -587,6 +697,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/gaming/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Gaming::V1::RealmsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Gaming::V1::PreviewRealmUpdateRequest.new
+            #
+            #   # Call the preview_realm_update method.
+            #   result = client.preview_realm_update request
+            #
+            #   # The returned object is of type Google::Cloud::Gaming::V1::PreviewRealmUpdateResponse.
+            #   p result
+            #
             def preview_realm_update request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -604,16 +729,20 @@ module Google
                 gapic_version: ::Google::Cloud::Gaming::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "realm.name" => request.realm.name
-              }
+              header_params = {}
+              if request.realm&.name
+                header_params["realm.name"] = request.realm.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.preview_realm_update.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.preview_realm_update.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @realms_service_stub.call_rpc :preview_realm_update, request, options: options do |response, operation|
@@ -637,22 +766,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for list_realms
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Gaming::V1::RealmsService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_realms.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_realms.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_realms to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Gaming::V1::RealmsService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_realms.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_realms.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.