Package Classes (3.17.0)

Summary of entries of Classes for translate.

Classes

Client

Client to bundle configuration needed for API requests.

TranslationServiceAsyncClient

Provides natural language translation operations.

TranslationServiceClient

Provides natural language translation operations.

ListAdaptiveMtDatasetsAsyncPager

A pager for iterating through list_adaptive_mt_datasets requests.

This class thinly wraps an initial ListAdaptiveMtDatasetsResponse object, and provides an __aiter__ method to iterate through its adaptive_mt_datasets field.

If there are more pages, the __aiter__ method will make additional ListAdaptiveMtDatasets requests and continue to iterate through the adaptive_mt_datasets field on the corresponding responses.

All the usual ListAdaptiveMtDatasetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAdaptiveMtDatasetsPager

A pager for iterating through list_adaptive_mt_datasets requests.

This class thinly wraps an initial ListAdaptiveMtDatasetsResponse object, and provides an __iter__ method to iterate through its adaptive_mt_datasets field.

If there are more pages, the __iter__ method will make additional ListAdaptiveMtDatasets requests and continue to iterate through the adaptive_mt_datasets field on the corresponding responses.

All the usual ListAdaptiveMtDatasetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAdaptiveMtFilesAsyncPager

A pager for iterating through list_adaptive_mt_files requests.

This class thinly wraps an initial ListAdaptiveMtFilesResponse object, and provides an __aiter__ method to iterate through its adaptive_mt_files field.

If there are more pages, the __aiter__ method will make additional ListAdaptiveMtFiles requests and continue to iterate through the adaptive_mt_files field on the corresponding responses.

All the usual ListAdaptiveMtFilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAdaptiveMtFilesPager

A pager for iterating through list_adaptive_mt_files requests.

This class thinly wraps an initial ListAdaptiveMtFilesResponse object, and provides an __iter__ method to iterate through its adaptive_mt_files field.

If there are more pages, the __iter__ method will make additional ListAdaptiveMtFiles requests and continue to iterate through the adaptive_mt_files field on the corresponding responses.

All the usual ListAdaptiveMtFilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAdaptiveMtSentencesAsyncPager

A pager for iterating through list_adaptive_mt_sentences requests.

This class thinly wraps an initial ListAdaptiveMtSentencesResponse object, and provides an __aiter__ method to iterate through its adaptive_mt_sentences field.

If there are more pages, the __aiter__ method will make additional ListAdaptiveMtSentences requests and continue to iterate through the adaptive_mt_sentences field on the corresponding responses.

All the usual ListAdaptiveMtSentencesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAdaptiveMtSentencesPager

A pager for iterating through list_adaptive_mt_sentences requests.

This class thinly wraps an initial ListAdaptiveMtSentencesResponse object, and provides an __iter__ method to iterate through its adaptive_mt_sentences field.

If there are more pages, the __iter__ method will make additional ListAdaptiveMtSentences requests and continue to iterate through the adaptive_mt_sentences field on the corresponding responses.

All the usual ListAdaptiveMtSentencesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDatasetsAsyncPager

A pager for iterating through list_datasets requests.

This class thinly wraps an initial ListDatasetsResponse object, and provides an __aiter__ method to iterate through its datasets field.

If there are more pages, the __aiter__ method will make additional ListDatasets requests and continue to iterate through the datasets field on the corresponding responses.

All the usual ListDatasetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDatasetsPager

A pager for iterating through list_datasets requests.

This class thinly wraps an initial ListDatasetsResponse object, and provides an __iter__ method to iterate through its datasets field.

If there are more pages, the __iter__ method will make additional ListDatasets requests and continue to iterate through the datasets field on the corresponding responses.

All the usual ListDatasetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListExamplesAsyncPager

A pager for iterating through list_examples requests.

This class thinly wraps an initial ListExamplesResponse object, and provides an __aiter__ method to iterate through its examples field.

If there are more pages, the __aiter__ method will make additional ListExamples requests and continue to iterate through the examples field on the corresponding responses.

All the usual ListExamplesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListExamplesPager

A pager for iterating through list_examples requests.

This class thinly wraps an initial ListExamplesResponse object, and provides an __iter__ method to iterate through its examples field.

If there are more pages, the __iter__ method will make additional ListExamples requests and continue to iterate through the examples field on the corresponding responses.

All the usual ListExamplesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListGlossariesAsyncPager

A pager for iterating through list_glossaries requests.

This class thinly wraps an initial ListGlossariesResponse object, and provides an __aiter__ method to iterate through its glossaries field.

If there are more pages, the __aiter__ method will make additional ListGlossaries requests and continue to iterate through the glossaries field on the corresponding responses.

All the usual ListGlossariesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListGlossariesPager

A pager for iterating through list_glossaries requests.

This class thinly wraps an initial ListGlossariesResponse object, and provides an __iter__ method to iterate through its glossaries field.

If there are more pages, the __iter__ method will make additional ListGlossaries requests and continue to iterate through the glossaries field on the corresponding responses.

All the usual ListGlossariesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListGlossaryEntriesAsyncPager

A pager for iterating through list_glossary_entries requests.

This class thinly wraps an initial ListGlossaryEntriesResponse object, and provides an __aiter__ method to iterate through its glossary_entries field.

If there are more pages, the __aiter__ method will make additional ListGlossaryEntries requests and continue to iterate through the glossary_entries field on the corresponding responses.

All the usual ListGlossaryEntriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListGlossaryEntriesPager

A pager for iterating through list_glossary_entries requests.

This class thinly wraps an initial ListGlossaryEntriesResponse object, and provides an __iter__ method to iterate through its glossary_entries field.

If there are more pages, the __iter__ method will make additional ListGlossaryEntries requests and continue to iterate through the glossary_entries field on the corresponding responses.

All the usual ListGlossaryEntriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListModelsAsyncPager

A pager for iterating through list_models requests.

This class thinly wraps an initial ListModelsResponse object, and provides an __aiter__ method to iterate through its models field.

If there are more pages, the __aiter__ method will make additional ListModels requests and continue to iterate through the models field on the corresponding responses.

All the usual ListModelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListModelsPager

A pager for iterating through list_models requests.

This class thinly wraps an initial ListModelsResponse object, and provides an __iter__ method to iterate through its models field.

If there are more pages, the __iter__ method will make additional ListModels requests and continue to iterate through the models field on the corresponding responses.

All the usual ListModelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AdaptiveMtDataset

An Adaptive MT Dataset.

AdaptiveMtFile

An AdaptiveMtFile.

AdaptiveMtSentence

An AdaptiveMt sentence entry.

AdaptiveMtTranslateRequest

The request for sending an AdaptiveMt translation query.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GlossaryConfig

Configures which glossary is used for a specific target language and defines options for applying that glossary.

ReferenceSentenceConfig

Message of caller-provided reference configuration.

ReferenceSentencePair

A pair of sentences used as reference in source and target languages.

ReferenceSentencePairList

A list of reference sentence pairs.

AdaptiveMtTranslateResponse

An AdaptiveMtTranslate response.

AdaptiveMtTranslation

An AdaptiveMt translation.

BatchDocumentInputConfig

Input configuration for BatchTranslateDocument request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BatchDocumentOutputConfig

Output configuration for BatchTranslateDocument request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BatchTransferResourcesResponse

Response message for BatchTransferResources.

TransferResourceResponse

Transfer response for a single resource.

BatchTranslateDocumentMetadata

State metadata for the batch translation operation.

State

State of the job.

BatchTranslateDocumentRequest

The BatchTranslateDocument request.

FormatConversionsEntry

The abstract base class for a message.

GlossariesEntry

The abstract base class for a message.

ModelsEntry

The abstract base class for a message.

BatchTranslateDocumentResponse

Stored in the google.longrunning.Operation.response][google.longrunning.Operation.response] field returned by BatchTranslateDocument if at least one document is translated successfully.

BatchTranslateMetadata

State metadata for the batch translation operation.

State

State of the job.

BatchTranslateResponse

Stored in the google.longrunning.Operation.response][google.longrunning.Operation.response] field returned by BatchTranslateText if at least one sentence is translated successfully.

BatchTranslateTextRequest

The batch translation request.

GlossariesEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

ModelsEntry

The abstract base class for a message.

CreateAdaptiveMtDatasetRequest

Request message for creating an AdaptiveMtDataset.

CreateDatasetMetadata

Metadata of create dataset operation.

CreateDatasetRequest

Request message for CreateDataset.

CreateGlossaryEntryRequest

Request message for CreateGlossaryEntry

CreateGlossaryMetadata

Stored in the google.longrunning.Operation.metadata][google.longrunning.Operation.metadata] field returned by CreateGlossary.

State

Enumerates the possible states that the creation request can be in.

CreateGlossaryRequest

Request message for CreateGlossary.

CreateModelMetadata

Metadata of create model operation.

CreateModelRequest

Request message for CreateModel.

Dataset

A dataset that hosts the examples (sentence pairs) used for translation models.

DatasetInputConfig

Input configuration for datasets.

InputFile

An input file.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DatasetOutputConfig

Output configuration for datasets.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeleteAdaptiveMtDatasetRequest

Request message for deleting an AdaptiveMtDataset.

DeleteAdaptiveMtFileRequest

The request for deleting an AdaptiveMt file.

DeleteDatasetMetadata

Metadata of delete dataset operation.

DeleteDatasetRequest

Request message for DeleteDataset.

DeleteGlossaryEntryRequest

Request message for Delete Glossary Entry

DeleteGlossaryMetadata

Stored in the google.longrunning.Operation.metadata][google.longrunning.Operation.metadata] field returned by DeleteGlossary.

State

Enumerates the possible states that the creation request can be in.

DeleteGlossaryRequest

Request message for DeleteGlossary.

DeleteGlossaryResponse

Stored in the google.longrunning.Operation.response][google.longrunning.Operation.response] field returned by DeleteGlossary.

DeleteModelMetadata

Metadata of delete model operation.

DeleteModelRequest

Request message for DeleteModel.

DetectLanguageRequest

The request message for language detection.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LabelsEntry

The abstract base class for a message.

DetectLanguageResponse

The response message for language detection.

DetectedLanguage

The response message for language detection.

DocumentInputConfig

A document translation request input config.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DocumentOutputConfig

A document translation request output config.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DocumentTranslation

A translated document message.

Example

A sentence pair.

ExportDataMetadata

Metadata of export data operation.

ExportDataRequest

Request message for ExportData.

FileInputSource

An inlined file.

GcsDestination

The Google Cloud Storage location for the output content.

GcsInputSource

The Google Cloud Storage location for the input content.

GcsOutputDestination

The Google Cloud Storage location for the output content.

GcsSource

The Google Cloud Storage location for the input content.

GetAdaptiveMtDatasetRequest

Request message for getting an Adaptive MT dataset.

GetAdaptiveMtFileRequest

The request for getting an AdaptiveMtFile.

GetDatasetRequest

Request message for GetDataset.

GetGlossaryEntryRequest

Request message for the Get Glossary Entry Api

GetGlossaryRequest

Request message for GetGlossary.

GetModelRequest

Request message for GetModel.

GetSupportedLanguagesRequest

The request message for discovering supported languages.

Glossary

Represents a glossary built from user-provided data.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LanguageCodePair

Used with unidirectional glossaries.

LanguageCodesSet

Used with equivalent term set glossaries.

GlossaryEntry

Represents a single entry in a glossary.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GlossaryTermsPair

Represents a single entry for an unidirectional glossary.

GlossaryTermsSet

Represents a single entry for an equivalent term set glossary. This is used for equivalent term sets where each term can be replaced by the other terms in the set.

GlossaryInputConfig

Input configuration for glossaries.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GlossaryTerm

Represents a single glossary term

ImportAdaptiveMtFileRequest

The request for importing an AdaptiveMt file along with its sentences.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportAdaptiveMtFileResponse

The response for importing an AdaptiveMtFile

ImportDataMetadata

Metadata of import data operation.

ImportDataRequest

Request message for ImportData.

InputConfig

Input configuration for BatchTranslateText request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ListAdaptiveMtDatasetsRequest

Request message for listing all Adaptive MT datasets that the requestor has access to.

ListAdaptiveMtDatasetsResponse

A list of AdaptiveMtDatasets.

ListAdaptiveMtFilesRequest

The request to list all AdaptiveMt files under a given dataset.

ListAdaptiveMtFilesResponse

The response for listing all AdaptiveMt files under a given dataset.

ListAdaptiveMtSentencesRequest

The request for listing Adaptive MT sentences from a Dataset/File.

ListAdaptiveMtSentencesResponse

List AdaptiveMt sentences response.

ListDatasetsRequest

Request message for ListDatasets.

ListDatasetsResponse

Response message for ListDatasets.

ListExamplesRequest

Request message for ListExamples.

ListExamplesResponse

Response message for ListExamples.

ListGlossariesRequest

Request message for ListGlossaries.

ListGlossariesResponse

Response message for ListGlossaries.

ListGlossaryEntriesRequest

Request message for ListGlossaryEntries

ListGlossaryEntriesResponse

Response message for ListGlossaryEntries

ListModelsRequest

Request message for ListModels.

ListModelsResponse

Response message for ListModels.

Model

A trained translation model.

OperationState

Possible states of long running operations.

OutputConfig

Output configuration for BatchTranslateText request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Romanization

A single romanization response.

RomanizeTextRequest

The request message for synchronous romanization.

RomanizeTextResponse

The response message for synchronous romanization.

SupportedLanguage

A single supported language response corresponds to information related to one supported language.

SupportedLanguages

The response message for discovering supported languages.

TranslateDocumentRequest

A document translation request.

LabelsEntry

The abstract base class for a message.

TranslateDocumentResponse

A translated document response message.

TranslateTextGlossaryConfig

Configures which glossary is used for a specific target language and defines options for applying that glossary.

TranslateTextRequest

The request message for synchronous translation.

LabelsEntry

The abstract base class for a message.

TranslateTextResponse

Translation

A single translation response.

TransliterationConfig

Configures transliteration feature on top of translation.

UpdateGlossaryEntryRequest

Request message for UpdateGlossaryEntry

UpdateGlossaryMetadata

Stored in the google.longrunning.Operation.metadata][google.longrunning.Operation.metadata] field returned by UpdateGlossary.

State

Enumerates the possible states that the update request can be in.

UpdateGlossaryRequest

Request message for the update glossary flow

TranslationServiceAsyncClient

Provides natural language translation operations.

TranslationServiceClient

Provides natural language translation operations.

ListGlossariesAsyncPager

A pager for iterating through list_glossaries requests.

This class thinly wraps an initial ListGlossariesResponse object, and provides an __aiter__ method to iterate through its glossaries field.

If there are more pages, the __aiter__ method will make additional ListGlossaries requests and continue to iterate through the glossaries field on the corresponding responses.

All the usual ListGlossariesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListGlossariesPager

A pager for iterating through list_glossaries requests.

This class thinly wraps an initial ListGlossariesResponse object, and provides an __iter__ method to iterate through its glossaries field.

If there are more pages, the __iter__ method will make additional ListGlossaries requests and continue to iterate through the glossaries field on the corresponding responses.

All the usual ListGlossariesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.