class Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client

Client for the GameServerDeploymentsService service.

The game server deployment is used to control the deployment of Agones fleets.

Attributes

game_server_deployments_service_stub[R]

@private

operations_client[R]

Get the associated client for long-running operations.

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

Public Class Methods

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

Configure the GameServerDeploymentsService Client class.

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

@example

# 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]

# File lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb, line 57
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 = 60.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
new() { |config| ... } click to toggle source

Create a new GameServerDeploymentsService client object.

@example

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

# Create a client using 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]

# File lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb, line 143
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 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_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

Public Instance Methods

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

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]

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

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, in the following 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.

# File lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb, line 380
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 timeout:      @config.timeout,
                         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
delete_game_server_deployment(request, options = nil) { |response, operation| ... } click to toggle source

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, in the following 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.

# File lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb, line 450
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 timeout:      @config.timeout,
                         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
fetch_deployment_state(request, options = nil) { |response, operation| ... } click to toggle source

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, in the following 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.

# File lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb, line 821
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 timeout:      @config.timeout,
                         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
get_game_server_deployment(request, options = nil) { |response, operation| ... } click to toggle source

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, in the following 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.

# File lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb, line 307
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 timeout:      @config.timeout,
                         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
get_game_server_deployment_rollout(request, options = nil) { |response, operation| ... } click to toggle source

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, in the following 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.

# File lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb, line 594
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 timeout:      @config.timeout,
                         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
list_game_server_deployments(request, options = nil) { |response, operation| ... } click to toggle source

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, in the following 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.

# File lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb, line 237
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 timeout:      @config.timeout,
                         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
preview_game_server_deployment_rollout(request, options = nil) { |response, operation| ... } click to toggle source

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.

# File lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb, line 750
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 timeout:      @config.timeout,
                         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
update_game_server_deployment(request, options = nil) { |response, operation| ... } click to toggle source

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.

# File lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb, line 524
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 timeout:      @config.timeout,
                         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
update_game_server_deployment_rollout(request, options = nil) { |response, operation| ... } click to toggle source

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.

# File lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb, line 672
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 timeout:      @config.timeout,
                         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