Output configuration for BatchTranslateText request.

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

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

    public Google\Protobuf\Internal\Message::byteSize()
     


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


    • return string
    public getGcsDestination()
     
    Google Cloud Storage destination for output content.

    For every single input file (for example, gs://a/b/c.[extension]), we
    generate at most 2 * n output files. (n is the # of target_language_codes
    in the BatchTranslateTextRequest).
    Output files (tsv) generated are compliant with RFC 4180 except that
    record delimiters are '\n' instead of '\r\n'. We don't provide any way to
    change record delimiters.
    While the input files are being processed, we write/update an index file
    'index.csv' under 'output_uri_prefix' (for example,
    gs://translation-test/index.csv) The index file is generated/updated as
    new files are being translated. The format is:
    input_file,target_language_code,translations_file,errors_file,
    glossary_translations_file,glossary_errors_file
    input_file is one file we matched using gcs_source.input_uri.
    target_language_code is provided in the request.
    translations_file contains the translations. (details provided below)
    errors_file contains the errors during processing of the file. (details
    below). Both translations_file and errors_file could be empty
    strings if we have no content to output.
    glossary_translations_file and glossary_errors_file are always empty
    strings if the input_file is tsv. They could also be empty if we have no
    content to output.
    Once a row is present in index.csv, the input/output matching never
    changes. Callers should also expect all the content in input_file are
    processed and ready to be consumed (that is, no partial output file is
    written).
    The format of translations_file (for target language code 'trg') is:
    gs://translation_test/a_bc'trg'_translations.[extension]
    If the input file extension is tsv, the output has the following
    columns:
    Column 1: ID of the request provided in the input, if it's not
    provided in the input, then the input row number is used (0-based).
    Column 2: source sentence.
    Column 3: translation without applying a glossary. Empty string if there
    is an error.
    Column 4 (only present if a glossary is provided in the request):
    translation after applying the glossary. Empty string if there is an
    error applying the glossary. Could be same string as column 3 if there is
    no glossary applied.
    If input file extension is a txt or html, the translation is directly
    written to the output file. If glossary is requested, a separate
    glossary_translations_file has format of
    gs://translation_test/a_bc'trg'_glossary_translations.[extension]
    The format of errors file (for target language code 'trg') is:
    gs://translation_test/a_bc'trg'_errors.[extension]
    If the input file extension is tsv, errors_file contains the following:
    Column 1: ID of the request provided in the input, if it's not
    provided in the input, then the input row number is used (0-based).
    Column 2: source sentence.
    Column 3: Error detail for the translation. Could be empty.
    Column 4 (only present if a glossary is provided in the request):
    Error when applying the glossary.
    If the input file extension is txt or html, glossary_error_file will be
    generated that contains error details. glossary_error_file has format of
    gs://translation_test/a_bc'trg'_glossary_errors.[extension]

    Generated from protobuf field .google.cloud.translation.v3.GcsDestination gcs_destination = 1;

    public Google\Protobuf\Internal\Message::jsonByteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data)
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input)
     


    • 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 setGcsDestination( $var)
     
    Google Cloud Storage destination for output content.

    For every single input file (for example, gs://a/b/c.[extension]), we
    generate at most 2 * n output files. (n is the # of target_language_codes
    in the BatchTranslateTextRequest).
    Output files (tsv) generated are compliant with RFC 4180 except that
    record delimiters are '\n' instead of '\r\n'. We don't provide any way to
    change record delimiters.
    While the input files are being processed, we write/update an index file
    'index.csv' under 'output_uri_prefix' (for example,
    gs://translation-test/index.csv) The index file is generated/updated as
    new files are being translated. The format is:
    input_file,target_language_code,translations_file,errors_file,
    glossary_translations_file,glossary_errors_file
    input_file is one file we matched using gcs_source.input_uri.
    target_language_code is provided in the request.
    translations_file contains the translations. (details provided below)
    errors_file contains the errors during processing of the file. (details
    below). Both translations_file and errors_file could be empty
    strings if we have no content to output.
    glossary_translations_file and glossary_errors_file are always empty
    strings if the input_file is tsv. They could also be empty if we have no
    content to output.
    Once a row is present in index.csv, the input/output matching never
    changes. Callers should also expect all the content in input_file are
    processed and ready to be consumed (that is, no partial output file is
    written).
    The format of translations_file (for target language code 'trg') is:
    gs://translation_test/a_bc'trg'_translations.[extension]
    If the input file extension is tsv, the output has the following
    columns:
    Column 1: ID of the request provided in the input, if it's not
    provided in the input, then the input row number is used (0-based).
    Column 2: source sentence.
    Column 3: translation without applying a glossary. Empty string if there
    is an error.
    Column 4 (only present if a glossary is provided in the request):
    translation after applying the glossary. Empty string if there is an
    error applying the glossary. Could be same string as column 3 if there is
    no glossary applied.
    If input file extension is a txt or html, the translation is directly
    written to the output file. If glossary is requested, a separate
    glossary_translations_file has format of
    gs://translation_test/a_bc'trg'_glossary_translations.[extension]
    The format of errors file (for target language code 'trg') is:
    gs://translation_test/a_bc'trg'_errors.[extension]
    If the input file extension is tsv, errors_file contains the following:
    Column 1: ID of the request provided in the input, if it's not
    provided in the input, then the input row number is used (0-based).
    Column 2: source sentence.
    Column 3: Error detail for the translation. Could be empty.
    Column 4 (only present if a glossary is provided in the request):
    Error when applying the glossary.
    If the input file extension is txt or html, glossary_error_file will be
    generated that contains error details. glossary_error_file has format of
    gs://translation_test/a_bc'trg'_glossary_errors.[extension]

    Generated from protobuf field .google.cloud.translation.v3.GcsDestination gcs_destination = 1;

    • return $this
    Properties
    protected $destination
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array)
    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)
    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $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)
    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