Method: projects.locations.gameServerDeployments.configs.list

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

HTTP request

GET https://gameservices.googleapis.com/v1/{parent=projects/*/locations/*/gameServerDeployments/*}/configs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name, in the following form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*.

Query parameters

Parameters
pageSize

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 nextPageToken to determine if there are more GameServerConfigs left to be queried.

pageToken

string

Optional. The nextPageToken value returned from a previous list request, if any.

filter

string

Optional. The filter to apply to list results.

orderBy

string

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for GameServerConfigsService.ListGameServerConfigs.

JSON representation
{
  "gameServerConfigs": [
    {
      object (GameServerConfig)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
gameServerConfigs[]

object (GameServerConfig)

The list of game server configs.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

unreachable[]

string

List of locations that could not be reached.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.