# frozen_string_literal: true # Copyright 2020 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/errors" require "google/cloud/gaming/v1/game_server_deployments_service_pb" module Google module Cloud module Gaming module V1 module GameServerDeploymentsService ## # Client for the GameServerDeploymentsService service. # # The game server deployment is used to control the deployment of Agones # fleets. # class Client include Paths # @private attr_reader :game_server_deployments_service_stub ## # Configure the GameServerDeploymentsService Client class. # # See {::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client::Configuration} # for a description of the configuration fields. # # ## Example # # To modify the configuration for all GameServerDeploymentsService clients: # # ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Gaming", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const&.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.list_game_server_deployments.timeout = 60.0 default_config.rpcs.list_game_server_deployments.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.get_game_server_deployment.timeout = 60.0 default_config.rpcs.get_game_server_deployment.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.create_game_server_deployment.timeout = 60.0 default_config.rpcs.delete_game_server_deployment.timeout = 60.0 default_config.rpcs.update_game_server_deployment.timeout = 60.0 default_config.rpcs.get_game_server_deployment_rollout.timeout = 60.0 default_config.rpcs.get_game_server_deployment_rollout.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.update_game_server_deployment_rollout.timeout = 60.0 default_config.rpcs.preview_game_server_deployment_rollout.timeout = 60.0 default_config.rpcs.preview_game_server_deployment_rollout.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.fetch_deployment_state.timeout = 120.0 default_config.rpcs.fetch_deployment_state.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end ## # Configure the GameServerDeploymentsService Client instance. # # The configuration is set to the derived mode, meaning that values can be changed, # but structural changes (adding new fields, etc.) are not allowed. Structural changes # should be made on {Client.configure}. # # See {::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # Create a new GameServerDeploymentsService client object. # # ## Examples # # To create a new GameServerDeploymentsService client with the default # configuration: # # client = ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new # # To create a new GameServerDeploymentsService client with a custom # configuration: # # client = ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the GameServerDeploymentsService client. # @yieldparam config [Client::Configuration] # def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/gaming/v1/game_server_deployments_service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the scope and endpoint are 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 && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(String) || credentials.is_a?(Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @game_server_deployments_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end ## # Get the associated client for long-running operations. # # @return [::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Operations] # attr_reader :operations_client # Service calls ## # Lists game server deployments in a given project and location. # # @overload list_game_server_deployments(request, options = nil) # Pass arguments to `list_game_server_deployments` via a request object, either of type # {::Google::Cloud::Gaming::V1::ListGameServerDeploymentsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Gaming::V1::ListGameServerDeploymentsRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload list_game_server_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) # Pass arguments to `list_game_server_deployments` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The parent resource name. Uses the form: # `projects/{project}/locations/{location}`. # @param page_size [::Integer] # Optional. The maximum number of items to return. If unspecified, the server # will pick an appropriate default. The server may return fewer items than # requested. A caller should only rely on response's # {::Google::Cloud::Gaming::V1::ListGameServerDeploymentsResponse#next_page_token next_page_token} to # determine if there are more GameServerDeployments left to be queried. # @param page_token [::String] # Optional. The next_page_token value returned from a previous List request, # if any. # @param filter [::String] # Optional. The filter to apply to list results. # @param order_by [::String] # Optional. Specifies the ordering of results following syntax at # https://cloud.google.com/apis/design/design_patterns#sorting_order. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Gaming::V1::GameServerDeployment>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::Gaming::V1::GameServerDeployment>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # def list_game_server_deployments request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::ListGameServerDeploymentsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_game_server_deployments.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Gaming::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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_game_server_deployments.timeout, metadata: metadata, retry_policy: @config.rpcs.list_game_server_deployments.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @game_server_deployments_service_stub.call_rpc :list_game_server_deployments, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @game_server_deployments_service_stub, :list_game_server_deployments, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets details of a single game server deployment. # # @overload get_game_server_deployment(request, options = nil) # Pass arguments to `get_game_server_deployment` via a request object, either of type # {::Google::Cloud::Gaming::V1::GetGameServerDeploymentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Gaming::V1::GetGameServerDeploymentRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload get_game_server_deployment(name: nil) # Pass arguments to `get_game_server_deployment` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of the game server delpoyment to retrieve. Uses the form: # # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Gaming::V1::GameServerDeployment] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Gaming::V1::GameServerDeployment] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # def get_game_server_deployment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::GetGameServerDeploymentRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_game_server_deployment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Gaming::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } 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_game_server_deployment.timeout, metadata: metadata, retry_policy: @config.rpcs.get_game_server_deployment.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @game_server_deployments_service_stub.call_rpc :get_game_server_deployment, 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 ## # Creates a new game server deployment in a given project and location. # # @overload create_game_server_deployment(request, options = nil) # Pass arguments to `create_game_server_deployment` via a request object, either of type # {::Google::Cloud::Gaming::V1::CreateGameServerDeploymentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Gaming::V1::CreateGameServerDeploymentRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload create_game_server_deployment(parent: nil, deployment_id: nil, game_server_deployment: nil) # Pass arguments to `create_game_server_deployment` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The parent resource name. Uses the form: # `projects/{project}/locations/{location}`. # @param deployment_id [::String] # Required. The ID of the game server delpoyment resource to be created. # @param game_server_deployment [::Google::Cloud::Gaming::V1::GameServerDeployment, ::Hash] # Required. The game server delpoyment resource to be created. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # def create_game_server_deployment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::CreateGameServerDeploymentRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_game_server_deployment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Gaming::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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_game_server_deployment.timeout, metadata: metadata, retry_policy: @config.rpcs.create_game_server_deployment.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @game_server_deployments_service_stub.call_rpc :create_game_server_deployment, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Deletes a single game server deployment. # # @overload delete_game_server_deployment(request, options = nil) # Pass arguments to `delete_game_server_deployment` via a request object, either of type # {::Google::Cloud::Gaming::V1::DeleteGameServerDeploymentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Gaming::V1::DeleteGameServerDeploymentRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload delete_game_server_deployment(name: nil) # Pass arguments to `delete_game_server_deployment` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of the game server delpoyment to delete. Uses the form: # # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # def delete_game_server_deployment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::DeleteGameServerDeploymentRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_game_server_deployment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Gaming::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } 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_game_server_deployment.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_game_server_deployment.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @game_server_deployments_service_stub.call_rpc :delete_game_server_deployment, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Patches a game server deployment. # # @overload update_game_server_deployment(request, options = nil) # Pass arguments to `update_game_server_deployment` via a request object, either of type # {::Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload update_game_server_deployment(game_server_deployment: nil, update_mask: nil) # Pass arguments to `update_game_server_deployment` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param game_server_deployment [::Google::Cloud::Gaming::V1::GameServerDeployment, ::Hash] # Required. The game server delpoyment to be updated. # Only fields specified in update_mask are updated. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Required. Mask of fields to update. At least one path must be supplied in # this field. For the `FieldMask` definition, see # # 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] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # def update_game_server_deployment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_game_server_deployment.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Gaming::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "game_server_deployment.name" => request.game_server_deployment.name } 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_game_server_deployment.timeout, metadata: metadata, retry_policy: @config.rpcs.update_game_server_deployment.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @game_server_deployments_service_stub.call_rpc :update_game_server_deployment, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets details a single game server deployment rollout. # # @overload get_game_server_deployment_rollout(request, options = nil) # Pass arguments to `get_game_server_deployment_rollout` via a request object, either of type # {::Google::Cloud::Gaming::V1::GetGameServerDeploymentRolloutRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Gaming::V1::GetGameServerDeploymentRolloutRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload get_game_server_deployment_rollout(name: nil) # Pass arguments to `get_game_server_deployment_rollout` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of the game server delpoyment to retrieve. Uses the form: # # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Gaming::V1::GameServerDeploymentRollout] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Gaming::V1::GameServerDeploymentRollout] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # def get_game_server_deployment_rollout request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::GetGameServerDeploymentRolloutRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_game_server_deployment_rollout.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Gaming::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } 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_game_server_deployment_rollout.timeout, metadata: metadata, retry_policy: @config.rpcs.get_game_server_deployment_rollout.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @game_server_deployments_service_stub.call_rpc :get_game_server_deployment_rollout, 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 ## # Patches a single game server deployment rollout. # The method will not return an error if the update does not affect any # existing realms. For example - if the default_game_server_config is changed # but all existing realms use the override, that is valid. Similarly, if a # non existing realm is explicitly called out in game_server_config_overrides # field, that will also not result in an error. # # @overload update_game_server_deployment_rollout(request, options = nil) # Pass arguments to `update_game_server_deployment_rollout` via a request object, either of type # {::Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRolloutRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRolloutRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload update_game_server_deployment_rollout(rollout: nil, update_mask: nil) # Pass arguments to `update_game_server_deployment_rollout` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param rollout [::Google::Cloud::Gaming::V1::GameServerDeploymentRollout, ::Hash] # Required. The game server delpoyment rollout to be updated. # Only fields specified in update_mask are updated. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Required. Mask of fields to update. At least one path must be supplied in # this field. For the `FieldMask` definition, see # # 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] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # def update_game_server_deployment_rollout request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRolloutRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_game_server_deployment_rollout.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Gaming::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "rollout.name" => request.rollout.name } 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_game_server_deployment_rollout.timeout, metadata: metadata, retry_policy: @config.rpcs.update_game_server_deployment_rollout.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @game_server_deployments_service_stub.call_rpc :update_game_server_deployment_rollout, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Previews the game server deployment rollout. This API does not mutate the # rollout resource. # # @overload preview_game_server_deployment_rollout(request, options = nil) # Pass arguments to `preview_game_server_deployment_rollout` via a request object, either of type # {::Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload preview_game_server_deployment_rollout(rollout: nil, update_mask: nil, preview_time: nil) # Pass arguments to `preview_game_server_deployment_rollout` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param rollout [::Google::Cloud::Gaming::V1::GameServerDeploymentRollout, ::Hash] # Required. The game server deployment rollout to be updated. # Only fields specified in update_mask are updated. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Optional. Mask of fields to update. At least one path must be supplied in # this field. For the `FieldMask` definition, see # # 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. Defaults to the immediately # after the proposed rollout completes. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # def preview_game_server_deployment_rollout request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.preview_game_server_deployment_rollout.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Gaming::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "rollout.name" => request.rollout.name } 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_game_server_deployment_rollout.timeout, metadata: metadata, retry_policy: @config.rpcs.preview_game_server_deployment_rollout.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @game_server_deployments_service_stub.call_rpc :preview_game_server_deployment_rollout, 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 ## # Retrieves information about the current state of the game server # deployment. Gathers all the Agones fleets and Agones autoscalers, # including fleets running an older version of the game server deployment. # # @overload fetch_deployment_state(request, options = nil) # Pass arguments to `fetch_deployment_state` via a request object, either of type # {::Google::Cloud::Gaming::V1::FetchDeploymentStateRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Gaming::V1::FetchDeploymentStateRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload fetch_deployment_state(name: nil) # Pass arguments to `fetch_deployment_state` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. The name of the game server delpoyment. Uses the form: # # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Gaming::V1::FetchDeploymentStateResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Gaming::V1::FetchDeploymentStateResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # def fetch_deployment_state request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::FetchDeploymentStateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.fetch_deployment_state.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Gaming::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } 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.fetch_deployment_state.timeout, metadata: metadata, retry_policy: @config.rpcs.fetch_deployment_state.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @game_server_deployments_service_stub.call_rpc :fetch_deployment_state, 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 ## # Configuration class for the GameServerDeploymentsService API. # # This class represents the configuration for GameServerDeploymentsService, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # 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_game_server_deployments # to 20 seconds, and all remaining timeouts to 10 seconds: # # ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.list_game_server_deployments.timeout = 20.0 # end # # To apply the above configuration only to a new client: # # client = ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new do |config| # config.timeout = 10.0 # config.rpcs.list_game_server_deployments.timeout = 20.0 # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"gameservices.googleapis.com"`. # @return [::String] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html)) # * (`GRPC::Core::Channel`) a gRPC channel with included credentials # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] channel_args # Extra parameters passed to the gRPC channel. Note: this is ignored if a # `GRPC::Core::Channel` object is provided as the credential. # @return [::Hash] # @!attribute [rw] interceptors # An array of interceptors that are run before calls are executed. # @return [::Array<::GRPC::ClientInterceptor>] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional gRPC headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # class Configuration extend ::Gapic::Config config_attr :endpoint, "gameservices.googleapis.com", ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the GameServerDeploymentsService API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_game_server_deployments` # @return [::Gapic::Config::Method] # attr_reader :list_game_server_deployments ## # RPC-specific configuration for `get_game_server_deployment` # @return [::Gapic::Config::Method] # attr_reader :get_game_server_deployment ## # RPC-specific configuration for `create_game_server_deployment` # @return [::Gapic::Config::Method] # attr_reader :create_game_server_deployment ## # RPC-specific configuration for `delete_game_server_deployment` # @return [::Gapic::Config::Method] # attr_reader :delete_game_server_deployment ## # RPC-specific configuration for `update_game_server_deployment` # @return [::Gapic::Config::Method] # attr_reader :update_game_server_deployment ## # RPC-specific configuration for `get_game_server_deployment_rollout` # @return [::Gapic::Config::Method] # attr_reader :get_game_server_deployment_rollout ## # RPC-specific configuration for `update_game_server_deployment_rollout` # @return [::Gapic::Config::Method] # attr_reader :update_game_server_deployment_rollout ## # RPC-specific configuration for `preview_game_server_deployment_rollout` # @return [::Gapic::Config::Method] # attr_reader :preview_game_server_deployment_rollout ## # RPC-specific configuration for `fetch_deployment_state` # @return [::Gapic::Config::Method] # attr_reader :fetch_deployment_state # @private def initialize parent_rpcs = nil list_game_server_deployments_config = parent_rpcs&.list_game_server_deployments if parent_rpcs&.respond_to? :list_game_server_deployments @list_game_server_deployments = ::Gapic::Config::Method.new list_game_server_deployments_config get_game_server_deployment_config = parent_rpcs&.get_game_server_deployment if parent_rpcs&.respond_to? :get_game_server_deployment @get_game_server_deployment = ::Gapic::Config::Method.new get_game_server_deployment_config create_game_server_deployment_config = parent_rpcs&.create_game_server_deployment if parent_rpcs&.respond_to? :create_game_server_deployment @create_game_server_deployment = ::Gapic::Config::Method.new create_game_server_deployment_config delete_game_server_deployment_config = parent_rpcs&.delete_game_server_deployment if parent_rpcs&.respond_to? :delete_game_server_deployment @delete_game_server_deployment = ::Gapic::Config::Method.new delete_game_server_deployment_config update_game_server_deployment_config = parent_rpcs&.update_game_server_deployment if parent_rpcs&.respond_to? :update_game_server_deployment @update_game_server_deployment = ::Gapic::Config::Method.new update_game_server_deployment_config get_game_server_deployment_rollout_config = parent_rpcs&.get_game_server_deployment_rollout if parent_rpcs&.respond_to? :get_game_server_deployment_rollout @get_game_server_deployment_rollout = ::Gapic::Config::Method.new get_game_server_deployment_rollout_config update_game_server_deployment_rollout_config = parent_rpcs&.update_game_server_deployment_rollout if parent_rpcs&.respond_to? :update_game_server_deployment_rollout @update_game_server_deployment_rollout = ::Gapic::Config::Method.new update_game_server_deployment_rollout_config preview_game_server_deployment_rollout_config = parent_rpcs&.preview_game_server_deployment_rollout if parent_rpcs&.respond_to? :preview_game_server_deployment_rollout @preview_game_server_deployment_rollout = ::Gapic::Config::Method.new preview_game_server_deployment_rollout_config fetch_deployment_state_config = parent_rpcs&.fetch_deployment_state if parent_rpcs&.respond_to? :fetch_deployment_state @fetch_deployment_state = ::Gapic::Config::Method.new fetch_deployment_state_config yield self if block_given? end end end end end end end end end