Documentation

Google_Service_GameServices_Resource_ProjectsLocationsGameServerDeploymentsConfigs extends Google_Service_Resource
in package

The "configs" collection of methods.

Typical usage is: $gameservicesService = new Google_Service_GameServices(...); $configs = $gameservicesService->configs;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_GameServices_Operation
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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_GameServices_Operation
Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.
get()  : Google_Service_GameServices_GameServerConfig
Gets details of a single game server config. (configs.get)
listProjectsLocationsGameServerDeploymentsConfigs()  : Google_Service_GameServices_ListGameServerConfigsResponse
Lists game server configs in a given project, location, and game server deployment. (configs.listProjectsLocationsGameServerDeploymentsConfigs)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

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.

public create(string $parent, Google_Service_GameServices_GameServerConfig $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_Operation

(configs.create)

Parameters
$parent : string

Required. The parent resource name. Uses the form: pro jects/{project}/locations/{location}/gameServerDeployments/{deployment}/.

$postBody : Google_Service_GameServices_GameServerConfig
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string configId Required. The ID of the game server config resource to be created.

Return values
Google_Service_GameServices_Operation

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

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

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_Operation

(configs.delete)

Parameters
$name : string

Required. The name of the game server config to delete. Uses the form: projects/{project}/locations/{location}/gameServerDeployments /{deployment}/configs/{config}.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_GameServices_Operation

get()

Gets details of a single game server config. (configs.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_GameServerConfig
Parameters
$name : string

Required. The name of the game server config to retrieve. Uses the form: projects/{project}/locations/{location}/gameServerDeployments /{deployment}/configs/{config}.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_GameServices_GameServerConfig

listProjectsLocationsGameServerDeploymentsConfigs()

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

public listProjectsLocationsGameServerDeploymentsConfigs(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_ListGameServerConfigsResponse
Parameters
$parent : string

Required. The parent resource name. Uses the form: pro jects/{project}/locations/{location}/gameServerDeployments/{deployment}/confi gs.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter Optional. The filter to apply to list results.

opt_param

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

opt_param

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

opt_param

string pageToken Optional. The next_page_token value returned from a previous list request, if any.

Return values
Google_Service_GameServices_ListGameServerConfigsResponse

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results