Documentation

Google_Service_Translate_Resource_ProjectsLocationsGlossaries extends Google_Service_Resource
in package

The "glossaries" collection of methods.

Typical usage is: $translateService = new Google_Service_Translate(...); $glossaries = $translateService->glossaries;

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.
create()  : Google_Service_Translate_Operation
Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist. (glossaries.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Translate_Operation
Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.
get()  : Google_Service_Translate_Glossary
Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.
listProjectsLocationsGlossaries()  : Google_Service_Translate_ListGlossariesResponse
Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist. (glossaries.listProjectsLocationsGlossaries)
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 —

create()

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

public create(string $parent, Google_Service_Translate_Glossary $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Translate_Operation
Parameters
$parent : string

Required. The project name.

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

Optional parameters.

Return values
Google_Service_Translate_Operation —

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

delete()

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

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Translate_Operation

(glossaries.delete)

Parameters
$name : string

Required. The name of the glossary to delete.

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

Optional parameters.

Return values
Google_Service_Translate_Operation —

listProjectsLocationsGlossaries()

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

public listProjectsLocationsGlossaries(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Translate_ListGlossariesResponse
Parameters
$parent : string

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

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

Optional parameters.

Tags
opt_param

int pageSize Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default.

opt_param

string pageToken Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossariesResponse.next_page_token] returned from the previous call to ListGlossaries method. The first page is returned if page_tokenis empty or missing.

opt_param

string filter Optional. Filter specifying constraints of a list operation. Specify the constraint by the format of "key=value", where key must be "src" or "tgt", and the value must be a valid language code. For multiple restrictions, concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used here, which means using 'en-US' and 'en' can lead to different results, which depends on the language code you used when you create the glossary. For the unidirectional glossaries, the "src" and "tgt" add restrictions on the source and target language code separately. For the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on the term set. For example: "src =en-US AND tgt=zh-CN" will only pick the unidirectional glossaries which exactly match the source language code as "en-US" and the target language code "zh-CN", but all equivalent term set glossaries which contain "en-US" and "zh-CN" in their language set will be picked. If missing, no filtering is performed.

Return values
Google_Service_Translate_ListGlossariesResponse —

convertToArrayAndStripNulls()

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

Search results