122 lines
4.9 KiB
PHP
122 lines
4.9 KiB
PHP
<?php
|
|
/*
|
|
* Copyright 2014 Google Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
|
* use this file except in compliance with the License. You may obtain a copy of
|
|
* the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations under
|
|
* the License.
|
|
*/
|
|
|
|
namespace Google\Service\CloudSearch\Resource;
|
|
|
|
use Google\Service\CloudSearch\DebugResponse;
|
|
use Google\Service\CloudSearch\RemoveActivityRequest;
|
|
use Google\Service\CloudSearch\RemoveActivityResponse;
|
|
use Google\Service\CloudSearch\SearchRequest;
|
|
use Google\Service\CloudSearch\SearchResponse;
|
|
use Google\Service\CloudSearch\SuggestRequest;
|
|
use Google\Service\CloudSearch\SuggestResponse;
|
|
|
|
/**
|
|
* The "query" collection of methods.
|
|
* Typical usage is:
|
|
* <code>
|
|
* $cloudsearchService = new Google\Service\CloudSearch(...);
|
|
* $query = $cloudsearchService->query;
|
|
* </code>
|
|
*/
|
|
class Query extends \Google\Service\Resource
|
|
{
|
|
/**
|
|
* Returns Debug information for Cloud Search Query API provides the search
|
|
* method. **Note:** This API requires a standard end user account to execute. A
|
|
* service account can't perform Query API requests directly; to use a service
|
|
* account to perform queries, set up [Google Workspace domain-wide delegation
|
|
* of authority](https://developers.google.com/cloud-
|
|
* search/docs/guides/delegation/). (query.debugSearch)
|
|
*
|
|
* @param SearchRequest $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return DebugResponse
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function debugSearch(SearchRequest $postBody, $optParams = [])
|
|
{
|
|
$params = ['postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('debugSearch', [$params], DebugResponse::class);
|
|
}
|
|
/**
|
|
* Provides functionality to remove logged activity for a user. Currently to be
|
|
* used only for Chat 1p clients **Note:** This API requires a standard end user
|
|
* account to execute. A service account can't perform Remove Activity requests
|
|
* directly; to use a service account to perform queries, set up [Google
|
|
* Workspace domain-wide delegation of
|
|
* authority](https://developers.google.com/cloud-
|
|
* search/docs/guides/delegation/). (query.removeActivity)
|
|
*
|
|
* @param RemoveActivityRequest $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return RemoveActivityResponse
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function removeActivity(RemoveActivityRequest $postBody, $optParams = [])
|
|
{
|
|
$params = ['postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('removeActivity', [$params], RemoveActivityResponse::class);
|
|
}
|
|
/**
|
|
* The Cloud Search Query API provides the search method, which returns the most
|
|
* relevant results from a user query. The results can come from Google
|
|
* Workspace apps, such as Gmail or Google Drive, or they can come from data
|
|
* that you have indexed from a third party. **Note:** This API requires a
|
|
* standard end user account to execute. A service account can't perform Query
|
|
* API requests directly; to use a service account to perform queries, set up
|
|
* [Google Workspace domain-wide delegation of
|
|
* authority](https://developers.google.com/cloud-
|
|
* search/docs/guides/delegation/). (query.search)
|
|
*
|
|
* @param SearchRequest $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return SearchResponse
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function search(SearchRequest $postBody, $optParams = [])
|
|
{
|
|
$params = ['postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('search', [$params], SearchResponse::class);
|
|
}
|
|
/**
|
|
* Provides suggestions for autocompleting the query. **Note:** This API
|
|
* requires a standard end user account to execute. A service account can't
|
|
* perform Query API requests directly; to use a service account to perform
|
|
* queries, set up [Google Workspace domain-wide delegation of
|
|
* authority](https://developers.google.com/cloud-
|
|
* search/docs/guides/delegation/). (query.suggest)
|
|
*
|
|
* @param SuggestRequest $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return SuggestResponse
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function suggest(SuggestRequest $postBody, $optParams = [])
|
|
{
|
|
$params = ['postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('suggest', [$params], SuggestResponse::class);
|
|
}
|
|
}
|
|
|
|
// Adding a class alias for backwards compatibility with the previous class name.
|
|
class_alias(Query::class, 'Google_Service_CloudSearch_Resource_Query');
|