Documentation

Google_Service_CloudSearch_Resource_DebugDatasourcesItems extends Google_Service_Resource
in package

The "items" collection of methods.

Typical usage is: $cloudsearchService = new Google_Service_CloudSearch(...); $items = $cloudsearchService->items;

Table of Contents

$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.
checkAccess()  : Google_Service_CloudSearch_CheckAccessResponse
Checks whether an item is accessible by specified principal. **Note:** This API requires an admin account to execute. (items.checkAccess)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
searchByViewUrl()  : Google_Service_CloudSearch_SearchItemsByViewUrlResponse
Fetches the item whose viewUrl exactly matches that of the URL provided in the request. **Note:** This API requires an admin account to execute.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

checkAccess()

Checks whether an item is accessible by specified principal. **Note:** This API requires an admin account to execute. (items.checkAccess)

public checkAccess(string $name, Google_Service_CloudSearch_Principal $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudSearch_CheckAccessResponse
Parameters
$name : string

Item name, format: datasources/{source_id}/items/{item_id}

$postBody : Google_Service_CloudSearch_Principal
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

Return values
Google_Service_CloudSearch_CheckAccessResponse —

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>
Tags
static
Return values
string —

$requestUrl

searchByViewUrl()

Fetches the item whose viewUrl exactly matches that of the URL provided in the request. **Note:** This API requires an admin account to execute.

public searchByViewUrl(string $name, Google_Service_CloudSearch_SearchItemsByViewUrlRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudSearch_SearchItemsByViewUrlResponse

(items.searchByViewUrl)

Parameters
$name : string

Source name, format: datasources/{source_id}

$postBody : Google_Service_CloudSearch_SearchItemsByViewUrlRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudSearch_SearchItemsByViewUrlResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results