Class: Google::Cloud::Translate::V3::BatchTranslateDocumentResponse

Inherits:

Object

• Object
• Google::Cloud::Translate::V3::BatchTranslateDocumentResponse

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/translate/v3/translation_service.rb

Overview

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

Instance Attribute Summary

• #end_time ⇒ ::Google::Protobuf::Timestamp

  The time when the operation is finished and google.longrunning.Operation.done is set to true.

• #failed_characters ⇒ ::Integer

  Number of characters that have failed to process (Unicode codepoints) in all documents.

• #failed_pages ⇒ ::Integer

  Number of pages that failed to process in all documents.

• #submit_time ⇒ ::Google::Protobuf::Timestamp

  Time when the operation was submitted.

• #total_billable_characters ⇒ ::Integer

  Number of billable characters (Unicode codepoints) in documents without clear page definition, such as XLSX.

• #total_billable_pages ⇒ ::Integer

  Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX).

• #total_characters ⇒ ::Integer

  Total number of characters (Unicode codepoints) in all documents.

• #total_pages ⇒ ::Integer

  Total number of pages to translate in all documents.

• #translated_characters ⇒ ::Integer

  Number of successfully translated characters (Unicode codepoints) in all documents.

• #translated_pages ⇒ ::Integer

  Number of successfully translated pages in all documents.

Instance Attribute Details

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns The time when the operation is finished and google.longrunning.Operation.done is set to true.

Returns:

• (::Google::Protobuf::Timestamp) —

  The time when the operation is finished and google.longrunning.Operation.done is set to true.

# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1365

class BatchTranslateDocumentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#failed_characters ⇒ ::Integer

Returns Number of characters that have failed to process (Unicode codepoints) in all documents.

Returns:

• (::Integer) —

  Number of characters that have failed to process (Unicode codepoints) in all documents.

# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1365

class BatchTranslateDocumentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#failed_pages ⇒ ::Integer

Returns Number of pages that failed to process in all documents. Documents without clear page definition (such as XLSX) are not counted.

Returns:

• (::Integer) —

  Number of pages that failed to process in all documents. Documents without clear page definition (such as XLSX) are not counted.

# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1365

class BatchTranslateDocumentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#submit_time ⇒ ::Google::Protobuf::Timestamp

Returns Time when the operation was submitted.

Returns:

• (::Google::Protobuf::Timestamp) —

  Time when the operation was submitted.

# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1365

class BatchTranslateDocumentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#total_billable_characters ⇒ ::Integer

Returns Number of billable characters (Unicode codepoints) in documents without clear page definition, such as XLSX.

Returns:

• (::Integer) —

  Number of billable characters (Unicode codepoints) in documents without clear page definition, such as XLSX.

# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1365

class BatchTranslateDocumentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#total_billable_pages ⇒ ::Integer

Returns Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX).

Returns:

• (::Integer) —

  Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX)

# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1365

class BatchTranslateDocumentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#total_characters ⇒ ::Integer

Returns Total number of characters (Unicode codepoints) in all documents.

Returns:

• (::Integer) —

  Total number of characters (Unicode codepoints) in all documents.

# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1365

class BatchTranslateDocumentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#total_pages ⇒ ::Integer

Returns Total number of pages to translate in all documents. Documents without clear page definition (such as XLSX) are not counted.

Returns:

• (::Integer) —

  Total number of pages to translate in all documents. Documents without clear page definition (such as XLSX) are not counted.

# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1365

class BatchTranslateDocumentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#translated_characters ⇒ ::Integer

Returns Number of successfully translated characters (Unicode codepoints) in all documents.

Returns:

• (::Integer) —

  Number of successfully translated characters (Unicode codepoints) in all documents.

# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1365

class BatchTranslateDocumentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#translated_pages ⇒ ::Integer

Returns Number of successfully translated pages in all documents. Documents without clear page definition (such as XLSX) are not counted.

Returns:

• (::Integer) —

  Number of successfully translated pages in all documents. Documents without clear page definition (such as XLSX) are not counted.

# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1365

class BatchTranslateDocumentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end