Documentation

Google_Service_Datastore_Resource_Projects extends Google_Service_Resource
in package

Application

The "projects" collection of methods.

Typical usage is: $datastoreService = new Google_Service_Datastore(...); $projects = $datastoreService->projects;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
allocateIds() : Google_Service_Datastore_AllocateIdsResponse: Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted. (projects.allocateIds)
beginTransaction() : Google_Service_Datastore_BeginTransactionResponse: Begins a new transaction. (projects.beginTransaction)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
commit() : Google_Service_Datastore_CommitResponse: Commits a transaction, optionally creating, deleting or modifying some entities. (projects.commit)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
export() : Google_Service_Datastore_GoogleLongrunningOperation: Exports a copy of all or a subset of entities from Google Cloud Datastore to another storage system, such as Google Cloud Storage. Recent updates to entities may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.
import() : Google_Service_Datastore_GoogleLongrunningOperation: Imports entities into Google Cloud Datastore. Existing entities with the same key are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportEntities operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Datastore. (projects.import)
lookup() : Google_Service_Datastore_LookupResponse: Looks up entities by key. (projects.lookup)
reserveIds() : Google_Service_Datastore_ReserveIdsResponse: Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.
rollback() : Google_Service_Datastore_RollbackResponse: Rolls back a transaction. (projects.rollback)
runQuery() : Google_Service_Datastore_RunQueryResponse: Queries for entities. (projects.runQuery)
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 —

allocateIds()

Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted. (projects.allocateIds)


    public
                allocateIds(string $projectId, Google_Service_Datastore_AllocateIdsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Datastore_AllocateIdsResponse

Parameters

$projectId : string: Required. The ID of the project against which to make the request.
$postBody : Google_Service_Datastore_AllocateIdsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Datastore_AllocateIdsResponse —

beginTransaction()

Begins a new transaction. (projects.beginTransaction)


    public
                beginTransaction(string $projectId, Google_Service_Datastore_BeginTransactionRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Datastore_BeginTransactionResponse

Parameters

$projectId : string: Required. The ID of the project against which to make the request.
$postBody : Google_Service_Datastore_BeginTransactionRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Datastore_BeginTransactionResponse —

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 —

commit()

Commits a transaction, optionally creating, deleting or modifying some entities. (projects.commit)


    public
                commit(string $projectId, Google_Service_Datastore_CommitRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Datastore_CommitResponse

Parameters

$projectId : string: Required. The ID of the project against which to make the request.
$postBody : Google_Service_Datastore_CommitRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Datastore_CommitResponse —

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

export()

Exports a copy of all or a subset of entities from Google Cloud Datastore to another storage system, such as Google Cloud Storage. Recent updates to entities may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.


    public
                export(string $projectId, Google_Service_Datastore_GoogleDatastoreAdminV1ExportEntitiesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Datastore_GoogleLongrunningOperation

(projects.export)

Parameters

$projectId : string: Required. Project ID against which to make the request.
$postBody : Google_Service_Datastore_GoogleDatastoreAdminV1ExportEntitiesRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Datastore_GoogleLongrunningOperation —

import()

Imports entities into Google Cloud Datastore. Existing entities with the same key are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportEntities operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Datastore. (projects.import)


    public
                import(string $projectId, Google_Service_Datastore_GoogleDatastoreAdminV1ImportEntitiesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Datastore_GoogleLongrunningOperation

Parameters

$projectId : string: Required. Project ID against which to make the request.
$postBody : Google_Service_Datastore_GoogleDatastoreAdminV1ImportEntitiesRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Datastore_GoogleLongrunningOperation —

lookup()

Looks up entities by key. (projects.lookup)


    public
                lookup(string $projectId, Google_Service_Datastore_LookupRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Datastore_LookupResponse

Parameters

$projectId : string: Required. The ID of the project against which to make the request.
$postBody : Google_Service_Datastore_LookupRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Datastore_LookupResponse —

reserveIds()

Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.


    public
                reserveIds(string $projectId, Google_Service_Datastore_ReserveIdsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Datastore_ReserveIdsResponse

(projects.reserveIds)

Parameters

$projectId : string: Required. The ID of the project against which to make the request.
$postBody : Google_Service_Datastore_ReserveIdsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Datastore_ReserveIdsResponse —

rollback()

Rolls back a transaction. (projects.rollback)


    public
                rollback(string $projectId, Google_Service_Datastore_RollbackRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Datastore_RollbackResponse

Parameters

$projectId : string: Required. The ID of the project against which to make the request.
$postBody : Google_Service_Datastore_RollbackRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Datastore_RollbackResponse —

runQuery()

Queries for entities. (projects.runQuery)


    public
                runQuery(string $projectId, Google_Service_Datastore_RunQueryRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Datastore_RunQueryResponse

Parameters

$projectId : string: Required. The ID of the project against which to make the request.
$postBody : Google_Service_Datastore_RunQueryRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Datastore_RunQueryResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —