class SettingsSearchapplications extends Resource (View source)

The "searchapplications" collection of methods.

Typical usage is:

 $cloudsearchService = new Google\Service\CloudSearch(...);
 $searchapplications = $cloudsearchService->settings_searchapplications;

Methods

create(SearchApplication $postBody, array $optParams = [])

Creates a search application. Note: This API requires an admin account to execute. (searchapplications.create)

delete(string $name, array $optParams = [])

Deletes a search application. Note: This API requires an admin account to execute. (searchapplications.delete)

get(string $name, array $optParams = [])

Gets the specified search application. Note: This API requires an admin account to execute. (searchapplications.get)

listSettingsSearchapplications(array $optParams = [])

Lists all search applications. Note: This API requires an admin account to execute. (searchapplications.listSettingsSearchapplications)

patch(string $name, SearchApplication $postBody, array $optParams = [])

Updates a search application. Note: This API requires an admin account to execute. (searchapplications.patch)

reset(string $name, ResetSearchApplicationRequest $postBody, array $optParams = [])

Resets a search application to default settings. This will return an empty response. Note: This API requires an admin account to execute.

update(string $name, SearchApplication $postBody, array $optParams = [])

Updates a search application. Note: This API requires an admin account to execute. (searchapplications.update)

Details

Operation create(SearchApplication $postBody, array $optParams = [])

Creates a search application. Note: This API requires an admin account to execute. (searchapplications.create)

Parameters

SearchApplication $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation delete(string $name, array $optParams = [])

Deletes a search application. Note: This API requires an admin account to execute. (searchapplications.delete)

Parameters

string $name

The name of the search application to be deleted. Format: applications/{application_id}.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

SearchApplication get(string $name, array $optParams = [])

Gets the specified search application. Note: This API requires an admin account to execute. (searchapplications.get)

Parameters

string $name

The name of the search application. Format: searchapplications/{application_id}.

array $optParams

Optional parameters.

Return Value

SearchApplication

Exceptions

Exception

ListSearchApplicationsResponse listSettingsSearchapplications(array $optParams = [])

Lists all search applications. Note: This API requires an admin account to execute. (searchapplications.listSettingsSearchapplications)

Parameters

array $optParams

Optional parameters.

Return Value

ListSearchApplicationsResponse

Exceptions

Exception

Operation patch(string $name, SearchApplication $postBody, array $optParams = [])

Updates a search application. Note: This API requires an admin account to execute. (searchapplications.patch)

Parameters

string $name

The name of the Search Application. Format: searchapplications/{application_id}.

SearchApplication $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation reset(string $name, ResetSearchApplicationRequest $postBody, array $optParams = [])

Resets a search application to default settings. This will return an empty response. Note: This API requires an admin account to execute.

(searchapplications.reset)

Parameters

string $name

The name of the search application to be reset. Format: applications/{application_id}.

ResetSearchApplicationRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation update(string $name, SearchApplication $postBody, array $optParams = [])

Updates a search application. Note: This API requires an admin account to execute. (searchapplications.update)

Parameters

string $name

The name of the Search Application. Format: searchapplications/{application_id}.

SearchApplication $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception