class ProjectsLocationsSynonymSets extends Resource (View source)

The "synonymSets" collection of methods.

Typical usage is:

 $contentwarehouseService = new Google\Service\Contentwarehouse(...);
 $synonymSets = $contentwarehouseService->projects_locations_synonymSets;

Methods

create(string $parent, GoogleCloudContentwarehouseV1SynonymSet $postBody, array $optParams = [])

Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS exception if a synonymset already exists for the context. (synonymSets.create)

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

Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception if the SynonymSet is not found. (synonymSets.delete)

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

Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception if the Synonymset does not exist (synonymSets.get)

listProjectsLocationsSynonymSets(string $parent, array $optParams = [])

Returns all SynonymSets (for all contexts) for the specified location.

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

Remove the existing SynonymSet for the context and replaces it with a new one. Throws a NOT_FOUND exception if the SynonymSet is not found.

Details

GoogleCloudContentwarehouseV1SynonymSet create(string $parent, GoogleCloudContentwarehouseV1SynonymSet $postBody, array $optParams = [])

Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS exception if a synonymset already exists for the context. (synonymSets.create)

Parameters

string $parent

Required. The parent name. Format: projects/{project_number}/locations/{location}.

GoogleCloudContentwarehouseV1SynonymSet $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1SynonymSet

Exceptions

Exception

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

Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception if the SynonymSet is not found. (synonymSets.delete)

Parameters

string $name

Required. The name of the synonymSet to delete Format: projects/{project_number}/locations/{location}/synonymSets/{context}.

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

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

Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception if the Synonymset does not exist (synonymSets.get)

Parameters

string $name

Required. The name of the synonymSet to retrieve Format: projects/{project_number}/locations/{location}/synonymSets/{context}.

array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1SynonymSet

Exceptions

Exception

GoogleCloudContentwarehouseV1ListSynonymSetsResponse listProjectsLocationsSynonymSets(string $parent, array $optParams = [])

Returns all SynonymSets (for all contexts) for the specified location.

(synonymSets.listProjectsLocationsSynonymSets)

Parameters

string $parent

Required. The parent name. Format: projects/{project_number}/locations/{location}.

array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1ListSynonymSetsResponse

Exceptions

Exception

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

Remove the existing SynonymSet for the context and replaces it with a new one. Throws a NOT_FOUND exception if the SynonymSet is not found.

(synonymSets.patch)

Parameters

string $name

Required. The name of the synonymSet to update Format: projects/{project_number}/locations/{location}/synonymSets/{context}.

GoogleCloudContentwarehouseV1SynonymSet $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1SynonymSet

Exceptions

Exception