GoogleApi.GameServices.V1beta.Api.Projects.gameservices_projects_locations_game_server_deployments_fetch_deployment_state

You're seeing just the function gameservices_projects_locations_game_server_deployments_fetch_deployment_state, go back to GoogleApi.GameServices.V1beta.Api.Projects module for more information.
Link to this function

gameservices_projects_locations_game_server_deployments_fetch_deployment_state(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

gameservices_projects_locations_game_server_deployments_fetch_deployment_state(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.GameServices.V1beta.Model.FetchDeploymentStateResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.GameServices.V1beta.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the game server delpoyment, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.GameServices.V1beta.Model.FetchDeploymentStateRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.GameServices.V1beta.Model.FetchDeploymentStateResponse{}} on success
  • {:error, info} on failure