The request message for synchronous translation.

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

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 

Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::clear()
     

    Clear all containing fields.

    • return
    public Google\Protobuf\Internal\Message::discardUnknownFields()
     

    Clear all unknown fields previously parsed.

    • return
    public getContents()
     

    Required. The content of the input in string format.

    We recommend the total content be less than 30k codepoints.
    Use BatchTranslateText for larger text.

    Generated from protobuf field repeated string contents = 1 [(.google.api.field_behavior) = REQUIRED];

    public 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.

    Generated from protobuf field .google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];

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

    Generated from protobuf field map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

    public getMimeType()
     

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

    Generated from protobuf field string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];

    • return string
    public 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,
      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.

    Generated from protobuf field string model = 6 [(.google.api.field_behavior) = OPTIONAL];

    • return string
    public 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.

    Generated from protobuf field string parent = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

    • return string
    public getSourceLanguageCode()
     

    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.

    Generated from protobuf field string source_language_code = 4 [(.google.api.field_behavior) = OPTIONAL];

    • return string
    public getTargetLanguageCode()
     

    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.

    Generated from protobuf field string target_language_code = 5 [(.google.api.field_behavior) = REQUIRED];

    • return string
    public Google\Protobuf\Internal\Message::jsonByteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
     

    Merges the contents of the specified message into current message.

    This method merges the contents of the specified message into the
    current message. Singular fields that are set in the specified message
    overwrite the corresponding fields in the current message. Repeated
    fields are appended. Map fields key-value pairs are overwritten.
    Singular/Oneof sub-messages are recursively merged. All overwritten
    sub-messages are deep-copied.

    • return
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
     

    Parses a json string to protobuf message.

    This function takes a string in the json wire format, matching the
    encoding output by serializeToJsonString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
     

    Parses a protocol buffer contained in a string.

    This function takes a string in the (non-human-readable) binary wire
    format, matching the encoding output by serializeToString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
     
    • ignore
    public Google\Protobuf\Internal\Message::parseFromStream( $input)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonString()
     

    Serialize the message to json string.

    • return string Serialized json protobuf data.
    public Google\Protobuf\Internal\Message::serializeToStream( $output)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToString()
     

    Serialize the message to string.

    • return string Serialized binary protobuf data.
    public setContents( $var)
     

    Required. The content of the input in string format.

    We recommend the total content be less than 30k codepoints.
    Use BatchTranslateText for larger text.

    Generated from protobuf field repeated string contents = 1 [(.google.api.field_behavior) = REQUIRED];

    • return $this
    public setGlossaryConfig( $var)
     

    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.

    Generated from protobuf field .google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];

    • return $this
    public setLabels( $var)
     

    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.

    Generated from protobuf field map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

    • return $this
    public setMimeType( $var)
     

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

    Generated from protobuf field string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];

    • return $this
    public setModel( $var)
     

    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.

    Generated from protobuf field string model = 6 [(.google.api.field_behavior) = OPTIONAL];

    • return $this
    public setParent( $var)
     

    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.

    Generated from protobuf field string parent = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

    • return $this
    public setSourceLanguageCode( $var)
     

    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.

    Generated from protobuf field string source_language_code = 4 [(.google.api.field_behavior) = OPTIONAL];

    • return $this
    public setTargetLanguageCode( $var)
     

    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.

    Generated from protobuf field string target_language_code = 5 [(.google.api.field_behavior) = REQUIRED];

    • return $this
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
     

    Populates the message from a user-supplied PHP array. Array keys
    correspond to Message properties and nested message properties.

    Example:

    $message->mergeFromArray([
        'name' => 'This is a message name',
        'interval' => [
             'startTime' => time() - 60,
             'endTime' => time(),
        ]
    ]);
    

    This method will trigger an error if it is passed data that cannot
    be converted to the correct type. For example, a StringValue field
    must receive data that is either a string or a StringValue object.

    • return
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
    protected Google\Protobuf\Internal\Message::readOneof( $number)
    protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
    protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
    protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
    protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
    Properties
    private $contents
     

    Required. The content of the input in string format.

    We recommend the total content be less than 30k codepoints.
    Use BatchTranslateText for larger text.

    Generated from protobuf field repeated string contents = 1 [(.google.api.field_behavior) = REQUIRED];

    private $glossary_config
     

    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.

    Generated from protobuf field .google.cloud.translation.v3.TranslateTextGlossaryConfig glossary_config = 7 [(.google.api.field_behavior) = OPTIONAL];

    private $labels
     

    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.

    Generated from protobuf field map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

    private $mime_type
     

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

    Generated from protobuf field string mime_type = 3 [(.google.api.field_behavior) = OPTIONAL];

    private $model
     

    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.

    Generated from protobuf field string model = 6 [(.google.api.field_behavior) = OPTIONAL];

    private $parent
     

    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.

    Generated from protobuf field string parent = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

    private $source_language_code
     

    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.

    Generated from protobuf field string source_language_code = 4 [(.google.api.field_behavior) = OPTIONAL];

    private $target_language_code
     

    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.

    Generated from protobuf field string target_language_code = 5 [(.google.api.field_behavior) = REQUIRED];

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $ignore_unknown, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     
    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array, $ignore_unknown)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     

    Tries to normalize the elements in $value into a provided protobuf
    wrapper type $class. If $value is any type other than array, we do
    not do any conversion, and instead rely on the existing protobuf
    type checking. If $value is an array, we process each element and
    try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       

      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         
        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         
        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         
        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         

        Tries to normalize the elements in $value into a provided protobuf
        wrapper type $class. If $value is any type other than array, we do
        not do any conversion, and instead rely on the existing protobuf
        type checking. If $value is an array, we process each element and
        try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           

          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             
            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only