Documentation

Google_Service_GameServices_Resource_ProjectsLocationsGameServerDeployments extends Google_Service_Resource
in package

Application

The "gameServerDeployments" collection of methods.

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

$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 deployment 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 deployment. (gameServerDeployments.delete)
fetchDeploymentState() : Google_Service_GameServices_FetchDeploymentStateResponse: Retrieves information about the current state of the game server deployment.
get() : Google_Service_GameServices_GameServerDeployment: Gets details of a single game server deployment. (gameServerDeployments.get)
getIamPolicy() : Google_Service_GameServices_Policy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
getRollout() : Google_Service_GameServices_GameServerDeploymentRollout: Gets details a single game server deployment rollout.
listProjectsLocationsGameServerDeployments() : Google_Service_GameServices_ListGameServerDeploymentsResponse: Lists game server deployments in a given project and location.
patch() : Google_Service_GameServices_Operation: Patches a game server deployment. (gameServerDeployments.patch)
previewRollout() : Google_Service_GameServices_PreviewGameServerDeploymentRolloutResponse: Previews the game server deployment rollout. This API does not mutate the rollout resource. (gameServerDeployments.previewRollout)
setIamPolicy() : Google_Service_GameServices_Policy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (gameServerDeployments.setIamPolicy)
testIamPermissions() : Google_Service_GameServices_TestIamPermissionsResponse: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.
updateRollout() : Google_Service_GameServices_Operation: 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. (gameServerDeployments.updateRollout)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

Return values

Google_Http_Request|expectedClass —

create()

Creates a new game server deployment in a given project and location.


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

(gameServerDeployments.create)

Parameters

$parent : string: Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.
$postBody : Google_Service_GameServices_GameServerDeployment
$optParams : array<string|int, mixed> = array(): Optional parameters.

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>

Return values

string —

$requestUrl

delete()

Deletes a single game server deployment. (gameServerDeployments.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 delpoyment to delete. Uses the form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GameServices_Operation —

fetchDeploymentState()

Retrieves information about the current state of the game server deployment.


    public
                fetchDeploymentState(string $name, Google_Service_GameServices_FetchDeploymentStateRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_FetchDeploymentStateResponse

Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment. (gameServerDeployments.fetchDeploymentState)

Parameters

$name : string: Required. The name of the game server delpoyment. Uses the form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}.
$postBody : Google_Service_GameServices_FetchDeploymentStateRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GameServices_FetchDeploymentStateResponse —

get()

Gets details of a single game server deployment. (gameServerDeployments.get)


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

Parameters

$name : string: Required. The name of the game server delpoyment to retrieve. Uses the form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GameServices_GameServerDeployment —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.


    public
                getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_Policy

(gameServerDeployments.getIamPolicy)

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GameServices_Policy —

getRollout()

Gets details a single game server deployment rollout.


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

(gameServerDeployments.getRollout)

Parameters

$name : string: Required. The name of the game server delpoyment to retrieve. Uses the form: projects/{project}/locations/{location}/gameServerD eployments/{deployment}/rollout.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GameServices_GameServerDeploymentRollout —

listProjectsLocationsGameServerDeployments()

Lists game server deployments in a given project and location.


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

(gameServerDeployments.listProjectsLocationsGameServerDeployments)

Parameters

$parent : string: Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GameServices_ListGameServerDeploymentsResponse —

patch()

Patches a game server deployment. (gameServerDeployments.patch)


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

Parameters

$name : string: The resource name of the game server deployment. Uses the form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}. For example, projects/my-project/locations/global/gameServerDeployments/my- deployment.
$postBody : Google_Service_GameServices_GameServerDeployment
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GameServices_Operation —

previewRollout()

Previews the game server deployment rollout. This API does not mutate the rollout resource. (gameServerDeployments.previewRollout)


    public
                previewRollout(string $name, Google_Service_GameServices_GameServerDeploymentRollout $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_PreviewGameServerDeploymentRolloutResponse

Parameters

$name : string: The resource name of the game server deployment rollout. Uses the form: projects/{project}/locations/{location}/gameServerDeployments /{deployment}/rollout. For example, projects/my- project/locations/global/gameServerDeployments/my-deployment/rollout.
$postBody : Google_Service_GameServices_GameServerDeploymentRollout
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GameServices_PreviewGameServerDeploymentRolloutResponse —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (gameServerDeployments.setIamPolicy)


    public
                setIamPolicy(string $resource, Google_Service_GameServices_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_GameServices_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GameServices_Policy —

testIamPermissions()

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.


    public
                testIamPermissions(string $resource, Google_Service_GameServices_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_TestIamPermissionsResponse

This operation may "fail open" without warning. (gameServerDeployments.testIamPermissions)

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_GameServices_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GameServices_TestIamPermissionsResponse —

updateRollout()

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. (gameServerDeployments.updateRollout)


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

Parameters

$name : string: The resource name of the game server deployment rollout. Uses the form: projects/{project}/locations/{location}/gameServerDeployments /{deployment}/rollout. For example, projects/my- project/locations/global/gameServerDeployments/my-deployment/rollout.
$postBody : Google_Service_GameServices_GameServerDeploymentRollout
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_GameServices_Operation —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —