Documentation

Google_Service_GameServices_Resource_ProjectsLocationsRealms extends Google_Service_Resource
in package

Application

The "realms" collection of methods.

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

$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 realm in a given project and location. (realms.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_GameServices_Operation: Deletes a single realm. (realms.delete)
get() : Google_Service_GameServices_Realm: Gets details of a single realm. (realms.get)
listProjectsLocationsRealms() : Google_Service_GameServices_ListRealmsResponse: Lists realms in a given project and location.
patch() : Google_Service_GameServices_Operation: Patches a single realm. (realms.patch)
previewUpdate() : Google_Service_GameServices_PreviewRealmUpdateResponse: Previews patches to a single realm. (realms.previewUpdate)
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 realm in a given project and location. (realms.create)


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

Parameters

$parent : string: Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.
$postBody : Google_Service_GameServices_Realm
$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 realm. (realms.delete)


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

Parameters

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

Return values

Google_Service_GameServices_Operation —

get()

Gets details of a single realm. (realms.get)


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

Parameters

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

Return values

Google_Service_GameServices_Realm —

listProjectsLocationsRealms()

Lists realms in a given project and location.


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

(realms.listProjectsLocationsRealms)

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_ListRealmsResponse —

patch()

Patches a single realm. (realms.patch)


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

Parameters

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

Return values

Google_Service_GameServices_Operation —

previewUpdate()

Previews patches to a single realm. (realms.previewUpdate)


    public
                previewUpdate(string $name, Google_Service_GameServices_Realm $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_GameServices_PreviewRealmUpdateResponse

Parameters

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

Return values

Google_Service_GameServices_PreviewRealmUpdateResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —