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 provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$gameServerDeploymentsServiceClient = new GameServerDeploymentsServiceClient();
try {
$formattedParent = $gameServerDeploymentsServiceClient->locationName('[PROJECT]', '[LOCATION]');
$deploymentId = 'deployment_id';
$gameServerDeployment = new GameServerDeployment();
$operationResponse = $gameServerDeploymentsServiceClient->createGameServerDeployment($formattedParent, $deploymentId, $gameServerDeployment);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $gameServerDeploymentsServiceClient->createGameServerDeployment($formattedParent, $deploymentId, $gameServerDeployment);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $gameServerDeploymentsServiceClient->resumeOperation($operationName, 'createGameServerDeployment');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$gameServerDeploymentsServiceClient->close();
}
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
This service has a new (beta) implementation. See Google\Cloud\Gaming\V1\Client\GameServerDeploymentsServiceClient to use the new surface.
Namespace
Google \ Cloud \ Gaming \ V1Methods
__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 |
↳ 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 |
↳ 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.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The parent resource name, in the following form:
|
deploymentId |
string
Required. The ID of the game server delpoyment resource to be created. |
gameServerDeployment |
Google\Cloud\Gaming\V1\GameServerDeployment
Required. The game server delpoyment resource to be created. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Gaming\V1\GameServerDeployment;
use Google\Cloud\Gaming\V1\GameServerDeploymentsServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent resource name, in the following form:
* `projects/{project}/locations/{location}`. Please see
* {@see GameServerDeploymentsServiceClient::locationName()} for help formatting this field.
* @param string $deploymentId The ID of the game server delpoyment resource to be created.
*/
function create_game_server_deployment_sample(string $formattedParent, string $deploymentId): void
{
// Create a client.
$gameServerDeploymentsServiceClient = new GameServerDeploymentsServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$gameServerDeployment = new GameServerDeployment();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $gameServerDeploymentsServiceClient->createGameServerDeployment(
$formattedParent,
$deploymentId,
$gameServerDeployment
);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var GameServerDeployment $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = GameServerDeploymentsServiceClient::locationName('[PROJECT]', '[LOCATION]');
$deploymentId = '[DEPLOYMENT_ID]';
create_game_server_deployment_sample($formattedParent, $deploymentId);
}
deleteGameServerDeployment
Deletes a single game server deployment.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the game server delpoyment to delete, in the following form:
|
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Gaming\V1\GameServerDeploymentsServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the game server delpoyment to delete, in the following form:
* `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. Please see
* {@see GameServerDeploymentsServiceClient::gameServerDeploymentName()} for help formatting this field.
*/
function delete_game_server_deployment_sample(string $formattedName): void
{
// Create a client.
$gameServerDeploymentsServiceClient = new GameServerDeploymentsServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $gameServerDeploymentsServiceClient->deleteGameServerDeployment($formattedName);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = GameServerDeploymentsServiceClient::gameServerDeploymentName(
'[PROJECT]',
'[LOCATION]',
'[DEPLOYMENT]'
);
delete_game_server_deployment_sample($formattedName);
}
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.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the game server delpoyment, in the following form:
|
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Gaming\V1\FetchDeploymentStateResponse;
use Google\Cloud\Gaming\V1\GameServerDeploymentsServiceClient;
/**
* @param string $name The name of the game server delpoyment, in the following form:
* `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.
*/
function fetch_deployment_state_sample(string $name): void
{
// Create a client.
$gameServerDeploymentsServiceClient = new GameServerDeploymentsServiceClient();
// Call the API and handle any network failures.
try {
/** @var FetchDeploymentStateResponse $response */
$response = $gameServerDeploymentsServiceClient->fetchDeploymentState($name);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$name = '[NAME]';
fetch_deployment_state_sample($name);
}
getGameServerDeployment
Gets details of a single game server deployment.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the game server delpoyment to retrieve, in the following form:
|
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Gaming\V1\GameServerDeployment;
use Google\Cloud\Gaming\V1\GameServerDeploymentsServiceClient;
/**
* @param string $formattedName The name of the game server delpoyment to retrieve, in the following form:
* `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. Please see
* {@see GameServerDeploymentsServiceClient::gameServerDeploymentName()} for help formatting this field.
*/
function get_game_server_deployment_sample(string $formattedName): void
{
// Create a client.
$gameServerDeploymentsServiceClient = new GameServerDeploymentsServiceClient();
// Call the API and handle any network failures.
try {
/** @var GameServerDeployment $response */
$response = $gameServerDeploymentsServiceClient->getGameServerDeployment($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = GameServerDeploymentsServiceClient::gameServerDeploymentName(
'[PROJECT]',
'[LOCATION]',
'[DEPLOYMENT]'
);
get_game_server_deployment_sample($formattedName);
}
getGameServerDeploymentRollout
Gets details a single game server deployment rollout.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the game server delpoyment to retrieve, in the following form:
|
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Gaming\V1\GameServerDeploymentRollout;
use Google\Cloud\Gaming\V1\GameServerDeploymentsServiceClient;
/**
* @param string $formattedName The name of the game server delpoyment to retrieve, in the following form:
* `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. Please see
* {@see GameServerDeploymentsServiceClient::gameServerDeploymentName()} for help formatting this field.
*/
function get_game_server_deployment_rollout_sample(string $formattedName): void
{
// Create a client.
$gameServerDeploymentsServiceClient = new GameServerDeploymentsServiceClient();
// Call the API and handle any network failures.
try {
/** @var GameServerDeploymentRollout $response */
$response = $gameServerDeploymentsServiceClient->getGameServerDeploymentRollout($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = GameServerDeploymentsServiceClient::gameServerDeploymentName(
'[PROJECT]',
'[LOCATION]',
'[DEPLOYMENT]'
);
get_game_server_deployment_rollout_sample($formattedName);
}
listGameServerDeployments
Lists game server deployments in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The parent resource name, in the following form:
|
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ 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. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Gaming\V1\GameServerDeployment;
use Google\Cloud\Gaming\V1\GameServerDeploymentsServiceClient;
/**
* @param string $formattedParent The parent resource name, in the following form:
* `projects/{project}/locations/{location}`. Please see
* {@see GameServerDeploymentsServiceClient::locationName()} for help formatting this field.
*/
function list_game_server_deployments_sample(string $formattedParent): void
{
// Create a client.
$gameServerDeploymentsServiceClient = new GameServerDeploymentsServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $gameServerDeploymentsServiceClient->listGameServerDeployments($formattedParent);
/** @var GameServerDeployment $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = GameServerDeploymentsServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_game_server_deployments_sample($formattedParent);
}
previewGameServerDeploymentRollout
Previews the game server deployment rollout. This API does not mutate the rollout resource.
Parameters | |
---|---|
Name | Description |
rollout |
Google\Cloud\Gaming\V1\GameServerDeploymentRollout
Required. The game server deployment rollout to be updated. Only fields specified in update_mask are updated. |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
Optional. Mask of fields to update. At least one path must be supplied in this field. For the |
↳ previewTime |
Timestamp
Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed rollout completes. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Gaming\V1\GameServerDeploymentRollout;
use Google\Cloud\Gaming\V1\GameServerDeploymentsServiceClient;
use Google\Cloud\Gaming\V1\PreviewGameServerDeploymentRolloutResponse;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function preview_game_server_deployment_rollout_sample(): void
{
// Create a client.
$gameServerDeploymentsServiceClient = new GameServerDeploymentsServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$rollout = new GameServerDeploymentRollout();
// Call the API and handle any network failures.
try {
/** @var PreviewGameServerDeploymentRolloutResponse $response */
$response = $gameServerDeploymentsServiceClient->previewGameServerDeploymentRollout($rollout);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateGameServerDeployment
Patches a game server deployment.
Parameters | |
---|---|
Name | Description |
gameServerDeployment |
Google\Cloud\Gaming\V1\GameServerDeployment
Required. The game server delpoyment to be updated. Only fields specified in update_mask are updated. |
updateMask |
Google\Protobuf\FieldMask
Required. Mask of fields to update. At least one path must be supplied in
this field. For the |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Gaming\V1\GameServerDeployment;
use Google\Cloud\Gaming\V1\GameServerDeploymentsServiceClient;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_game_server_deployment_sample(): void
{
// Create a client.
$gameServerDeploymentsServiceClient = new GameServerDeploymentsServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$gameServerDeployment = new GameServerDeployment();
$updateMask = new FieldMask();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $gameServerDeploymentsServiceClient->updateGameServerDeployment(
$gameServerDeployment,
$updateMask
);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var GameServerDeployment $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
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.
Parameters | |
---|---|
Name | Description |
rollout |
Google\Cloud\Gaming\V1\GameServerDeploymentRollout
Required. The game server delpoyment rollout to be updated. Only fields specified in update_mask are updated. |
updateMask |
Google\Protobuf\FieldMask
Required. Mask of fields to update. At least one path must be supplied in
this field. For the |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Gaming\V1\GameServerDeployment;
use Google\Cloud\Gaming\V1\GameServerDeploymentRollout;
use Google\Cloud\Gaming\V1\GameServerDeploymentsServiceClient;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_game_server_deployment_rollout_sample(): void
{
// Create a client.
$gameServerDeploymentsServiceClient = new GameServerDeploymentsServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$rollout = new GameServerDeploymentRollout();
$updateMask = new FieldMask();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $gameServerDeploymentsServiceClient->updateGameServerDeploymentRollout(
$rollout,
$updateMask
);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var GameServerDeployment $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
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. |
Constants
SERVICE_NAME
Value: 'google.cloud.gaming.v1.GameServerDeploymentsService'
The name of the service.
SERVICE_ADDRESS
Value: 'gameservices.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.