Console
    Contact Us Start free

    Cloud Translation V3 Client - Class TranslateTextRequest (1.13.3)

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

    The request message for synchronous translation.

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

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ contents
    array

    Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

    ↳ mime_type
    string

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

    ↳ source_language_code
    string

    Optional. The ISO-639 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.

    ↳ target_language_code
    string

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

    ↳ parent
    string

    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.

    ↳ model
    string

    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 , For global (non-regionalized) requests, use location-id global . For example, projects/{project-number-or-id}/locations/global/models/general/nmt . If not provided, the default Google model (NMT) will be used.

    ↳ glossary_config
    Google\Cloud\Translate\V3\TranslateTextGlossaryConfig

    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.

    ↳ labels
    array| Google\Protobuf\Internal\MapField

    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/advanced/labels for more information.

    getContents

    Required. The content of the input in string format.

    We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setContents

    Required. The content of the input in string format.

    We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getMimeType

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

    Returns
    Type
    Description
    string

    setMimeType

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getSourceLanguageCode

    Optional. The ISO-639 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.

    Returns
    Type
    Description
    string

    setSourceLanguageCode

    Optional. The ISO-639 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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getTargetLanguageCode

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

    Returns
    Type
    Description
    string

    setTargetLanguageCode

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getParent

    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.

    Returns
    Type
    Description
    string

    setParent

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getModel

    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 , For global (non-regionalized) requests, use location-id global . For example, projects/{project-number-or-id}/locations/global/models/general/nmt . If not provided, the default Google model (NMT) will be used.
    Returns
    Type
    Description
    string

    setModel

    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 , For global (non-regionalized) requests, use location-id global . For example, projects/{project-number-or-id}/locations/global/models/general/nmt . If not provided, the default Google model (NMT) will be used.
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getGlossaryConfig

    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.

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

    hasGlossaryConfig

    clearGlossaryConfig

    setGlossaryConfig

    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.

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

    getLabels

    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/advanced/labels for more information.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    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/advanced/labels for more information.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: