Documentation

Google_Service_GameServices_Resource_ProjectsLocationsRealmsGameServerClusters extends Google_Service_Resource
in package

The "gameServerClusters" collection of methods.

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

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 cluster in a given project and location.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_GameServices_Operation
Deletes a single game server cluster. (gameServerClusters.delete)
get()  : Google_Service_GameServices_GameServerCluster
Gets details of a single game server cluster. (gameServerClusters.get)
listProjectsLocationsRealmsGameServerClusters()  : Google_Service_GameServices_ListGameServerClustersResponse
Lists game server clusters in a given project and location.
patch()  : Google_Service_GameServices_Operation
Patches a single game server cluster. (gameServerClusters.patch)
previewCreate()  : Google_Service_GameServices_PreviewCreateGameServerClusterResponse
Previews creation of a new game server cluster in a given project and location. (gameServerClusters.previewCreate)
previewDelete()  : Google_Service_GameServices_PreviewDeleteGameServerClusterResponse
Previews deletion of a single game server cluster.
previewUpdate()  : Google_Service_GameServices_PreviewUpdateGameServerClusterResponse
Previews updating a GameServerCluster. (gameServerClusters.previewUpdate)
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 cluster in a given project and location.

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

(gameServerClusters.create)

Parameters
$parent : string

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}/realms/{realm-id}.

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

Optional parameters.

Tags
opt_param

string gameServerClusterId Required. The ID of the game server cluster 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 cluster. (gameServerClusters.delete)

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

Required. The name of the game server cluster to delete. Uses the form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.

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

Optional parameters.

Return values
Google_Service_GameServices_Operation —

get()

Gets details of a single game server cluster. (gameServerClusters.get)

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

Required. The name of the game server cluster to retrieve. Uses the form: projects/{project}/locations/{location}/realms /{realm-id}/gameServerClusters/{cluster}.

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

Optional parameters.

Return values
Google_Service_GameServices_GameServerCluster —

listProjectsLocationsRealmsGameServerClusters()

Lists game server clusters in a given project and location.

public listProjectsLocationsRealmsGameServerClusters(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_ListGameServerClustersResponse

(gameServerClusters.listProjectsLocationsRealmsGameServerClusters)

Parameters
$parent : string

Required. The parent resource name. Uses the form: "projects/{project}/locations/{location}/realms/{realm}".

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

Optional parameters.

Tags
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

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

opt_param

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

opt_param

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

Return values
Google_Service_GameServices_ListGameServerClustersResponse —

patch()

Patches a single game server cluster. (gameServerClusters.patch)

public patch(string $name, Google_Service_GameServices_GameServerCluster $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_Operation
Parameters
$name : string

Required. The resource name of the game server cluster. Uses the form: projects/{project}/locations/{location}/realms/{realm}/gameSe rverClusters/{cluster}. For example, projects/my- project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem- cluster.

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

Optional parameters.

Tags
opt_param

string updateMask 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

Return values
Google_Service_GameServices_Operation —

previewCreate()

Previews creation of a new game server cluster in a given project and location. (gameServerClusters.previewCreate)

public previewCreate(string $parent, Google_Service_GameServices_GameServerCluster $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_PreviewCreateGameServerClusterResponse
Parameters
$parent : string

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}/realms/{realm}.

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

Optional parameters.

Tags
opt_param

string gameServerClusterId Required. The ID of the game server cluster resource to be created.

opt_param

string previewTime Optional. The target timestamp to compute the preview.

Return values
Google_Service_GameServices_PreviewCreateGameServerClusterResponse —

previewDelete()

Previews deletion of a single game server cluster.

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

(gameServerClusters.previewDelete)

Parameters
$name : string

Required. The name of the game server cluster to delete. Uses the form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.

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

Optional parameters.

Tags
opt_param

string previewTime Optional. The target timestamp to compute the preview.

Return values
Google_Service_GameServices_PreviewDeleteGameServerClusterResponse —

previewUpdate()

Previews updating a GameServerCluster. (gameServerClusters.previewUpdate)

public previewUpdate(string $name, Google_Service_GameServices_GameServerCluster $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_PreviewUpdateGameServerClusterResponse
Parameters
$name : string

Required. The resource name of the game server cluster. Uses the form: projects/{project}/locations/{location}/realms/{realm}/gameSe rverClusters/{cluster}. For example, projects/my- project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem- cluster.

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

Optional parameters.

Tags
opt_param

string previewTime Optional. The target timestamp to compute the preview.

opt_param

string updateMask 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

Return values
Google_Service_GameServices_PreviewUpdateGameServerClusterResponse —

convertToArrayAndStripNulls()

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

Search results