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

$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();
}

Namespace

Methods

__construct

createGameServerDeployment

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

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

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

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

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

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

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

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

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

resumeOperation

static::gameServerDeploymentName

static::gameServerDeploymentRolloutName

static::locationName

static::parseName

Constants

SERVICE_NAME

Value: 'google.cloud.gaming.v1.GameServerDeploymentsService'

SERVICE_ADDRESS

Value: 'gameservices.googleapis.com'

DEFAULT_SERVICE_PORT

Value: 443

CODEGEN_NAME

Value: 'gapic'