Cloud Translation V3 Client - Class Glossary (1.17.5)

Reference documentation and code samples for the Cloud Translation V3 Client class Glossary.

Represents a glossary built from user-provided data.

Generated from protobuf message google.cloud.translation.v3.Glossary

Namespace

Google \ Cloud \ Translate \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The resource name of the glossary. Glossary names have the form projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}.
↳ language_pair Google\Cloud\Translate\V3\Glossary\LanguageCodePair

Used with unidirectional glossaries.
↳ language_codes_set Google\Cloud\Translate\V3\Glossary\LanguageCodesSet

Used with equivalent term set glossaries.
↳ input_config Google\Cloud\Translate\V3\GlossaryInputConfig

Required. Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.
↳ entry_count int

Output only. The number of entries defined in the glossary.
↳ submit_time Google\Protobuf\Timestamp

Output only. When CreateGlossary was called.
↳ end_time Google\Protobuf\Timestamp

Output only. When the glossary creation was finished.
↳ display_name string

Optional. The display name of the glossary.

getName

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

Returns
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getLanguagePair

Used with unidirectional glossaries.

Returns
Type Description
Google\Cloud\Translate\V3\Glossary\LanguageCodePair|null

hasLanguagePair

setLanguagePair

Used with unidirectional glossaries.

Parameter
Name Description
var Google\Cloud\Translate\V3\Glossary\LanguageCodePair
Returns
Type Description
$this

getLanguageCodesSet

Used with equivalent term set glossaries.

Returns
Type Description
Google\Cloud\Translate\V3\Glossary\LanguageCodesSet|null

hasLanguageCodesSet

setLanguageCodesSet

Used with equivalent term set glossaries.

Parameter
Name Description
var Google\Cloud\Translate\V3\Glossary\LanguageCodesSet
Returns
Type Description
$this

getInputConfig

Required. Provides examples to build the glossary from.

Total glossary must not exceed 10M Unicode codepoints.

Returns
Type Description
Google\Cloud\Translate\V3\GlossaryInputConfig|null

hasInputConfig

clearInputConfig

setInputConfig

Required. Provides examples to build the glossary from.

Total glossary must not exceed 10M Unicode codepoints.

Parameter
Name Description
var Google\Cloud\Translate\V3\GlossaryInputConfig
Returns
Type Description
$this

getEntryCount

Output only. The number of entries defined in the glossary.

Returns
Type Description
int

setEntryCount

Output only. The number of entries defined in the glossary.

Parameter
Name Description
var int
Returns
Type Description
$this

getSubmitTime

Output only. When CreateGlossary was called.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasSubmitTime

clearSubmitTime

setSubmitTime

Output only. When CreateGlossary was called.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEndTime

Output only. When the glossary creation was finished.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Output only. When the glossary creation was finished.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDisplayName

Optional. The display name of the glossary.

Returns
Type Description
string

setDisplayName

Optional. The display name of the glossary.

Parameter
Name Description
var string
Returns
Type Description
$this

getLanguages

Returns
Type Description
string