Google Cloud Game Servers V1 Client - Class RealmsServiceClient (1.2.3)

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

Service Description: A realm is a grouping of game server clusters that are considered interchangeable.

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:

$realmsServiceClient = new RealmsServiceClient();
try {
    $formattedParent = $realmsServiceClient->locationName('[PROJECT]', '[LOCATION]');
    $realmId = 'realm_id';
    $realm = new Realm();
    $operationResponse = $realmsServiceClient->createRealm($formattedParent, $realmId, $realm);
    $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 = $realmsServiceClient->createRealm($formattedParent, $realmId, $realm);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $realmsServiceClient->resumeOperation($operationName, 'createRealm');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $realmsServiceClient->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\RealmsServiceClient to use the new surface.

Namespace

Google \ Cloud \ Gaming \ V1

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.

createRealm

Creates a new realm in a given project and location.

Parameters
Name	Description
`parent`	`string` Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`.
`realmId`	`string` Required. The ID of the realm resource to be created.
`realm`	`Google\Cloud\Gaming\V1\Realm` Required. The realm 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Gaming\V1\Realm;
use Google\Cloud\Gaming\V1\RealmsServiceClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent resource name, in the following form:
 *                                `projects/{project}/locations/{location}`. Please see
 *                                {@see RealmsServiceClient::locationName()} for help formatting this field.
 * @param string $realmId         The ID of the realm resource to be created.
 * @param string $realmTimeZone   Time zone where all policies targeting this realm are evaluated. The value
 *                                of this field must be from the IANA time zone database:
 *                                https://www.iana.org/time-zones.
 */
function create_realm_sample(
    string $formattedParent,
    string $realmId,
    string $realmTimeZone
): void {
    // Create a client.
    $realmsServiceClient = new RealmsServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $realm = (new Realm())
        ->setTimeZone($realmTimeZone);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $realmsServiceClient->createRealm($formattedParent, $realmId, $realm);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Realm $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 = RealmsServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $realmId = '[REALM_ID]';
    $realmTimeZone = '[TIME_ZONE]';

    create_realm_sample($formattedParent, $realmId, $realmTimeZone);
}

deleteRealm

Deletes a single realm.

Parameters
Name	Description
`name`	`string` Required. The name of the realm to delete, in the following form: `projects/{project}/locations/{location}/realms/{realm}`.
`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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Gaming\V1\RealmsServiceClient;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the realm to delete, in the following form:
 *                              `projects/{project}/locations/{location}/realms/{realm}`. Please see
 *                              {@see RealmsServiceClient::realmName()} for help formatting this field.
 */
function delete_realm_sample(string $formattedName): void
{
    // Create a client.
    $realmsServiceClient = new RealmsServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $realmsServiceClient->deleteRealm($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 = RealmsServiceClient::realmName('[PROJECT]', '[LOCATION]', '[REALM]');

    delete_realm_sample($formattedName);
}

getRealm

Gets details of a single realm.

Parameters
Name	Description
`name`	`string` Required. The name of the realm to retrieve, in the following form: `projects/{project}/locations/{location}/realms/{realm}`.
`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\Realm`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Gaming\V1\Realm;
use Google\Cloud\Gaming\V1\RealmsServiceClient;

/**
 * @param string $formattedName The name of the realm to retrieve, in the following form:
 *                              `projects/{project}/locations/{location}/realms/{realm}`. Please see
 *                              {@see RealmsServiceClient::realmName()} for help formatting this field.
 */
function get_realm_sample(string $formattedName): void
{
    // Create a client.
    $realmsServiceClient = new RealmsServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var Realm $response */
        $response = $realmsServiceClient->getRealm($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 = RealmsServiceClient::realmName('[PROJECT]', '[LOCATION]', '[REALM]');

    get_realm_sample($formattedName);
}

listRealms

Lists realms in a given project and location.

Parameters
Name	Description
`parent`	`string` Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`.
`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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Gaming\V1\Realm;
use Google\Cloud\Gaming\V1\RealmsServiceClient;

/**
 * @param string $formattedParent The parent resource name, in the following form:
 *                                `projects/{project}/locations/{location}`. Please see
 *                                {@see RealmsServiceClient::locationName()} for help formatting this field.
 */
function list_realms_sample(string $formattedParent): void
{
    // Create a client.
    $realmsServiceClient = new RealmsServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $realmsServiceClient->listRealms($formattedParent);

        /** @var Realm $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 = RealmsServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_realms_sample($formattedParent);
}

previewRealmUpdate

Previews patches to a single realm.

Parameters
Name	Description
`realm`	`Google\Cloud\Gaming\V1\Realm` Required. The realm to be updated. Only fields specified in update_mask are updated.
`updateMask`	`Google\Protobuf\FieldMask` Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
`optionalArgs`	`array` Optional.
`↳ previewTime`	`Timestamp` Optional. The target timestamp to compute the preview.
`↳ 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\PreviewRealmUpdateResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Gaming\V1\PreviewRealmUpdateResponse;
use Google\Cloud\Gaming\V1\Realm;
use Google\Cloud\Gaming\V1\RealmsServiceClient;
use Google\Protobuf\FieldMask;

/**
 * @param string $realmTimeZone Time zone where all policies targeting this realm are evaluated. The value
 *                              of this field must be from the IANA time zone database:
 *                              https://www.iana.org/time-zones.
 */
function preview_realm_update_sample(string $realmTimeZone): void
{
    // Create a client.
    $realmsServiceClient = new RealmsServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $realm = (new Realm())
        ->setTimeZone($realmTimeZone);
    $updateMask = new FieldMask();

    // Call the API and handle any network failures.
    try {
        /** @var PreviewRealmUpdateResponse $response */
        $response = $realmsServiceClient->previewRealmUpdate($realm, $updateMask);
        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
{
    $realmTimeZone = '[TIME_ZONE]';

    preview_realm_update_sample($realmTimeZone);
}

updateRealm

Patches a single realm.

Parameters
Name	Description
`realm`	`Google\Cloud\Gaming\V1\Realm` Required. The realm to be updated. Only fields specified in update_mask are updated.
`updateMask`	`Google\Protobuf\FieldMask` Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
`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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Gaming\V1\Realm;
use Google\Cloud\Gaming\V1\RealmsServiceClient;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * @param string $realmTimeZone Time zone where all policies targeting this realm are evaluated. The value
 *                              of this field must be from the IANA time zone database:
 *                              https://www.iana.org/time-zones.
 */
function update_realm_sample(string $realmTimeZone): void
{
    // Create a client.
    $realmsServiceClient = new RealmsServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $realm = (new Realm())
        ->setTimeZone($realmTimeZone);
    $updateMask = new FieldMask();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $realmsServiceClient->updateRealm($realm, $updateMask);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Realm $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
{
    $realmTimeZone = '[TIME_ZONE]';

    update_realm_sample($realmTimeZone);
}

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::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::realmName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`realm`	`string`

Returns
Type	Description
`string`	The formatted realm 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

location: projects/{project}/locations/{location}
realm: projects/{project}/locations/{location}/realms/{realm}

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.RealmsService'

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.