1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Translate
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsGlossaries

ProjectsLocationsGlossaries

class ProjectsLocationsGlossaries extends Resource (View source)

The "glossaries" collection of methods.

Typical usage is:

 $translateService = new Google\Service\Translate(...);
 $glossaries = $translateService->projects_locations_glossaries;

Methods

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

Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist. (glossaries.create)

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

Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.

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

Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.

ListGlossariesResponse
listProjectsLocationsGlossaries(string $parent, array $optParams = [])

Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist. (glossaries.listProjectsLocationsGlossaries)

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

Updates a glossary. A LRO is used since the update can be async if the glossary's entry file is updated. (glossaries.patch)

Details

at line 44
Operation create(string $parent, Glossary $postBody, array $optParams = [])

Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist. (glossaries.create)

Parameters

string $parent

Required. The project name.
Glossary $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.

(glossaries.delete)

Parameters

string $name

Required. The name of the glossary to delete.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 75
Glossary get(string $name, array $optParams = [])

Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.

(glossaries.get)

Parameters

string $name

Required. The name of the glossary to retrieve.
array $optParams

Optional parameters.

Return Value

Glossary

Exceptions

Exception

at line 115
ListGlossariesResponse listProjectsLocationsGlossaries(string $parent, array $optParams = [])

Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist. (glossaries.listProjectsLocationsGlossaries)

Parameters

string $parent

Required. The name of the project from which to list all of the glossaries.
array $optParams

Optional parameters.

Return Value

ListGlossariesResponse

Exceptions

Exception

at line 136
Operation patch(string $name, Glossary $postBody, array $optParams = [])

Updates a glossary. A LRO is used since the update can be async if the glossary's entry file is updated. (glossaries.patch)

Parameters

string $name

Required. The resource name of the glossary. Glossary names have the form projects/{project-number-or-id}/locations/{location- id}/glossaries/{glossary-id}.
Glossary $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception