Google Cloud Game Servers V1 Client - Class GameServerDeploymentsServiceClient (1.1.1)

Version 1.1.1

• 1.2.6 (latest)
• 1.2.5
• 1.1.1
• 1.0.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Game Servers V1 Client class GameServerDeploymentsServiceClient.

Service Description: The game server deployment is used to control the deployment of Agones fleets.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Gaming \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array Optional. Options for configuring the service API wrapper.
↳ apiEndpoint	string The address of the API remote host. May optionally include the port, formatted as "
↳ credentials	string|array|FetchAuthTokenInterface|CredentialsWrapper The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig	array Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries	bool Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createGameServerDeployment

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

The async variant is Google\Cloud\Gaming\V1\Client\BaseClient\self::createGameServerDeploymentAsync() .

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\CreateGameServerDeploymentRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteGameServerDeployment

Deletes a single game server deployment.

The async variant is Google\Cloud\Gaming\V1\Client\BaseClient\self::deleteGameServerDeploymentAsync() .

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\DeleteGameServerDeploymentRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

fetchDeploymentState

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.

The async variant is Google\Cloud\Gaming\V1\Client\BaseClient\self::fetchDeploymentStateAsync() .

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\FetchDeploymentStateRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Gaming\V1\FetchDeploymentStateResponse

getGameServerDeployment

Gets details of a single game server deployment.

The async variant is Google\Cloud\Gaming\V1\Client\BaseClient\self::getGameServerDeploymentAsync() .

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\GetGameServerDeploymentRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Gaming\V1\GameServerDeployment

getGameServerDeploymentRollout

Gets details a single game server deployment rollout.

The async variant is Google\Cloud\Gaming\V1\Client\BaseClient\self::getGameServerDeploymentRolloutAsync() .

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\GetGameServerDeploymentRolloutRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Gaming\V1\GameServerDeploymentRollout

listGameServerDeployments

Lists game server deployments in a given project and location.

The async variant is Google\Cloud\Gaming\V1\Client\BaseClient\self::listGameServerDeploymentsAsync() .

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\ListGameServerDeploymentsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

previewGameServerDeploymentRollout

Previews the game server deployment rollout. This API does not mutate the rollout resource.

The async variant is Google\Cloud\Gaming\V1\Client\BaseClient\self::previewGameServerDeploymentRolloutAsync() .

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\PreviewGameServerDeploymentRolloutRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\Gaming\V1\PreviewGameServerDeploymentRolloutResponse

updateGameServerDeployment

Patches a game server deployment.

The async variant is Google\Cloud\Gaming\V1\Client\BaseClient\self::updateGameServerDeploymentAsync() .

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\UpdateGameServerDeploymentRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateGameServerDeploymentRollout

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.

The async variant is Google\Cloud\Gaming\V1\Client\BaseClient\self::updateGameServerDeploymentRolloutAsync() .

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\UpdateGameServerDeploymentRolloutRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createGameServerDeploymentAsync

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\CreateGameServerDeploymentRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteGameServerDeploymentAsync

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\DeleteGameServerDeploymentRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

fetchDeploymentStateAsync

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\FetchDeploymentStateRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getGameServerDeploymentAsync

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\GetGameServerDeploymentRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getGameServerDeploymentRolloutAsync

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\GetGameServerDeploymentRolloutRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listGameServerDeploymentsAsync

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\ListGameServerDeploymentsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

previewGameServerDeploymentRolloutAsync

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\PreviewGameServerDeploymentRolloutRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateGameServerDeploymentAsync

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\UpdateGameServerDeploymentRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateGameServerDeploymentRolloutAsync

Parameters
Name	Description
request	Google\Cloud\Gaming\V1\UpdateGameServerDeploymentRolloutRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
operationName	string The name of the long running operation
methodName	string The name of the method used to start the operation

Returns
Type	Description
Google\ApiCore\OperationResponse

static::gameServerDeploymentName

Formats a string containing the fully-qualified path to represent a game_server_deployment resource.

Parameters
Name	Description
project	string
location	string
deployment	string

Returns
Type	Description
string	The formatted game_server_deployment resource.

static::gameServerDeploymentRolloutName

Formats a string containing the fully-qualified path to represent a game_server_deployment_rollout resource.

Parameters
Name	Description
project	string
location	string
deployment	string

Returns
Type	Description
string	The formatted game_server_deployment_rollout resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	The formatted location resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

• gameServerDeployment: projects/{project}/locations/{location}/gameServerDeployments/{deployment}
• gameServerDeploymentRollout: projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout
• location: projects/{project}/locations/{location}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
formattedName	string The formatted name string
template	string Optional name of template to match

Returns
Type	Description
array	An associative array from name component IDs to component values.