class Google::Cloud::Gaming::V1::GameServerConfigsService::Client

Client for the GameServerConfigsService service.

The game server config configures the game servers in an Agones fleet.

Attributes

game_server_configs_service_stub[R]

@private

operations_client[R]

Get the associated client for long-running operations.

@return [::Google::Cloud::Gaming::V1::GameServerConfigsService::Operations]

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the GameServerConfigsService Client class.

See {::Google::Cloud::Gaming::V1::GameServerConfigsService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all GameServerConfigsService clients
::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/gaming/v1/game_server_configs_service/client.rb, line 56
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_configs.timeout = 60.0
    default_config.rpcs.list_game_server_configs.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_game_server_config.timeout = 60.0
    default_config.rpcs.get_game_server_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_game_server_config.timeout = 60.0

    default_config.rpcs.delete_game_server_config.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new GameServerConfigsService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the GameServerConfigsService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/gaming/v1/game_server_configs_service/client.rb, line 123
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_configs_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 endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  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
  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_configs_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Gaming::V1::GameServerConfigsService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the GameServerConfigsService 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::GameServerConfigsService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/gaming/v1/game_server_configs_service/client.rb, line 102
def configure
  yield @config if block_given?
  @config
end
create_game_server_config(request, options = nil) { |response, operation| ... } click to toggle source

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

@overload create_game_server_config(request, options = nil)

Pass arguments to `create_game_server_config` via a request object, either of type
{::Google::Cloud::Gaming::V1::CreateGameServerConfigRequest} or an equivalent Hash.

@param request [::Google::Cloud::Gaming::V1::CreateGameServerConfigRequest, ::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_config(parent: nil, config_id: nil, game_server_config: nil)

Pass arguments to `create_game_server_config` 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, in the following form:
  `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/`.
@param config_id [::String]
  Required. The ID of the game server config resource to be created.
@param game_server_config [::Google::Cloud::Gaming::V1::GameServerConfig, ::Hash]
  Required. The game server config 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.

# File lib/google/cloud/gaming/v1/game_server_configs_service/client.rb, line 362
def create_game_server_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::CreateGameServerConfigRequest

  # 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_config.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_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_game_server_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @game_server_configs_service_stub.call_rpc :create_game_server_config, 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
delete_game_server_config(request, options = nil) { |response, operation| ... } click to toggle source

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

@overload delete_game_server_config(request, options = nil)

Pass arguments to `delete_game_server_config` via a request object, either of type
{::Google::Cloud::Gaming::V1::DeleteGameServerConfigRequest} or an equivalent Hash.

@param request [::Google::Cloud::Gaming::V1::DeleteGameServerConfigRequest, ::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_config(name: nil)

Pass arguments to `delete_game_server_config` 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 config to delete, in the following form:
  `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.

@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.

# File lib/google/cloud/gaming/v1/game_server_configs_service/client.rb, line 433
def delete_game_server_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::DeleteGameServerConfigRequest

  # 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_config.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_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_game_server_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @game_server_configs_service_stub.call_rpc :delete_game_server_config, 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
get_game_server_config(request, options = nil) { |response, operation| ... } click to toggle source

Gets details of a single game server config.

@overload get_game_server_config(request, options = nil)

Pass arguments to `get_game_server_config` via a request object, either of type
{::Google::Cloud::Gaming::V1::GetGameServerConfigRequest} or an equivalent Hash.

@param request [::Google::Cloud::Gaming::V1::GetGameServerConfigRequest, ::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_config(name: nil)

Pass arguments to `get_game_server_config` 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 config to retrieve, in the following form:
  `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Gaming::V1::GameServerConfig] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Gaming::V1::GameServerConfig]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/gaming/v1/game_server_configs_service/client.rb, line 287
def get_game_server_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::GetGameServerConfigRequest

  # 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_config.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_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_game_server_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @game_server_configs_service_stub.call_rpc :get_game_server_config, 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
list_game_server_configs(request, options = nil) { |response, operation| ... } click to toggle source

Lists game server configs in a given project, location, and game server deployment.

@overload list_game_server_configs(request, options = nil)

Pass arguments to `list_game_server_configs` via a request object, either of type
{::Google::Cloud::Gaming::V1::ListGameServerConfigsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Gaming::V1::ListGameServerConfigsRequest, ::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_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)

Pass arguments to `list_game_server_configs` 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, in the following form:
  `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*`.
@param page_size [::Integer]
  Optional. The maximum number of items to return.  If unspecified, server
  will pick an appropriate default. Server may return fewer items than
  requested. A caller should only rely on response's
  {::Google::Cloud::Gaming::V1::ListGameServerConfigsResponse#next_page_token next_page_token} to
  determine if there are more GameServerConfigs 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::GameServerConfig>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Gaming::V1::GameServerConfig>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/gaming/v1/game_server_configs_service/client.rb, line 217
def list_game_server_configs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::ListGameServerConfigsRequest

  # 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_configs.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_configs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_game_server_configs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @game_server_configs_service_stub.call_rpc :list_game_server_configs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @game_server_configs_service_stub, :list_game_server_configs, 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