Class TranslateTextRequest (2.2.0)

public sealed class TranslateTextRequest : IMessage<TranslateTextRequest>, IEquatable<TranslateTextRequest>, IDeepCloneable<TranslateTextRequest>, IBufferMessage, IMessage

The request message for synchronous translation.

Inheritance

Object > TranslateTextRequest

Implements

IMessage<TranslateTextRequest>, IEquatable<TranslateTextRequest>, IDeepCloneable<TranslateTextRequest>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Translate.V3

Assembly

Google.Cloud.Translate.V3.dll

Constructors

TranslateTextRequest()

public TranslateTextRequest()

TranslateTextRequest(TranslateTextRequest)

public TranslateTextRequest(TranslateTextRequest other)

Parameter
Name	Description
`other`	`TranslateTextRequest`

Properties

public RepeatedField<string> Contents { get; }

Required. The content of the input in string format. We recommend the total content be less than 30k codepoints. Use BatchTranslateText for larger text.

Property Value
Type	Description
`RepeatedField<String>`

GlossaryConfig

public TranslateTextGlossaryConfig GlossaryConfig { get; set; }

Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.

Property Value
Type	Description
`TranslateTextGlossaryConfig`

Labels

public MapField<string, string> Labels { get; }

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

See https://cloud.google.com/translate/docs/labels for more information.

Property Value
Type	Description
`MapField<String, String>`

MimeType

public string MimeType { get; set; }

Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".

Property Value
Type	Description
`String`

Model

public string Model { get; set; }

Optional. The model type requested for this translation.

The format depends on model type:

AutoML Translation models: projects/{project-number-or-id}/locations/{location-id}/models/{model-id}
General (built-in) models: projects/{project-number-or-id}/locations/{location-id}/models/general/nmt, projects/{project-number-or-id}/locations/{location-id}/models/general/base

For global (non-regionalized) requests, use location-id global. For example, projects/{project-number-or-id}/locations/global/models/general/nmt.

If missing, the system decides which google base model to use.

Property Value
Type	Description
`String`

Parent

public string Parent { get; set; }

Required. Project or location to make a call. Must refer to a caller's project.

Format: projects/{project-number-or-id} or projects/{project-number-or-id}/locations/{location-id}.

For global calls, use projects/{project-number-or-id}/locations/global or projects/{project-number-or-id}.

Non-global location is required for requests using AutoML models or custom glossaries.

Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.

Property Value
Type	Description
`String`

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type	Description
`LocationName`

SourceLanguageCode

public string SourceLanguageCode { get; set; }

Optional. The BCP-47 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response.

Property Value
Type	Description
`String`

TargetLanguageCode

public string TargetLanguageCode { get; set; }

Required. The BCP-47 language code to use for translation of the input text, set to one of the language codes listed in Language Support.

Property Value
Type	Description
`String`