Reference documentation and code samples for the Cloud Translation V3 API class Google::Cloud::Translate::V3::BatchTranslateDocumentMetadata.
State metadata for the batch translation operation.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#failed_characters
def failed_characters() -> ::Integer
Returns
- (::Integer) — Number of characters that have failed to process (Unicode codepoints) in all documents so far.
#failed_characters=
def failed_characters=(value) -> ::Integer
Parameter
- value (::Integer) — Number of characters that have failed to process (Unicode codepoints) in all documents so far.
Returns
- (::Integer) — Number of characters that have failed to process (Unicode codepoints) in all documents so far.
#failed_pages
def failed_pages() -> ::Integer
Returns
- (::Integer) — Number of pages that failed to process in all documents so far. Documents without clear page definition (such as XLSX) are not counted.
#failed_pages=
def failed_pages=(value) -> ::Integer
Parameter
- value (::Integer) — Number of pages that failed to process in all documents so far. Documents without clear page definition (such as XLSX) are not counted.
Returns
- (::Integer) — Number of pages that failed to process in all documents so far. Documents without clear page definition (such as XLSX) are not counted.
#state
def state() -> ::Google::Cloud::Translate::V3::BatchTranslateDocumentMetadata::State
Returns
- (::Google::Cloud::Translate::V3::BatchTranslateDocumentMetadata::State) — The state of the operation.
#state=
def state=(value) -> ::Google::Cloud::Translate::V3::BatchTranslateDocumentMetadata::State
Parameter
- value (::Google::Cloud::Translate::V3::BatchTranslateDocumentMetadata::State) — The state of the operation.
Returns
- (::Google::Cloud::Translate::V3::BatchTranslateDocumentMetadata::State) — The state of the operation.
#submit_time
def submit_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Time when the operation was submitted.
#submit_time=
def submit_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Time when the operation was submitted.
Returns
- (::Google::Protobuf::Timestamp) — Time when the operation was submitted.
#total_billable_characters
def total_billable_characters() -> ::Integer
Returns
- (::Integer) — Number of billable characters (Unicode codepoints) in documents without clear page definition (such as XLSX) so far.
#total_billable_characters=
def total_billable_characters=(value) -> ::Integer
Parameter
- value (::Integer) — Number of billable characters (Unicode codepoints) in documents without clear page definition (such as XLSX) so far.
Returns
- (::Integer) — Number of billable characters (Unicode codepoints) in documents without clear page definition (such as XLSX) so far.
#total_billable_pages
def total_billable_pages() -> ::Integer
Returns
- (::Integer) — Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX) so far.
#total_billable_pages=
def total_billable_pages=(value) -> ::Integer
Parameter
- value (::Integer) — Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX) so far.
Returns
- (::Integer) — Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX) so far.
#total_characters
def total_characters() -> ::Integer
Returns
- (::Integer) — Total number of characters (Unicode codepoints) in all documents so far.
#total_characters=
def total_characters=(value) -> ::Integer
Parameter
- value (::Integer) — Total number of characters (Unicode codepoints) in all documents so far.
Returns
- (::Integer) — Total number of characters (Unicode codepoints) in all documents so far.
#total_pages
def total_pages() -> ::Integer
Returns
- (::Integer) — Total number of pages to translate in all documents so far. Documents without clear page definition (such as XLSX) are not counted.
#total_pages=
def total_pages=(value) -> ::Integer
Parameter
- value (::Integer) — Total number of pages to translate in all documents so far. Documents without clear page definition (such as XLSX) are not counted.
Returns
- (::Integer) — Total number of pages to translate in all documents so far. Documents without clear page definition (such as XLSX) are not counted.
#translated_characters
def translated_characters() -> ::Integer
Returns
- (::Integer) — Number of successfully translated characters (Unicode codepoints) in all documents so far.
#translated_characters=
def translated_characters=(value) -> ::Integer
Parameter
- value (::Integer) — Number of successfully translated characters (Unicode codepoints) in all documents so far.
Returns
- (::Integer) — Number of successfully translated characters (Unicode codepoints) in all documents so far.
#translated_pages
def translated_pages() -> ::Integer
Returns
- (::Integer) — Number of successfully translated pages in all documents so far. Documents without clear page definition (such as XLSX) are not counted.
#translated_pages=
def translated_pages=(value) -> ::Integer
Parameter
- value (::Integer) — Number of successfully translated pages in all documents so far. Documents without clear page definition (such as XLSX) are not counted.
Returns
- (::Integer) — Number of successfully translated pages in all documents so far. Documents without clear page definition (such as XLSX) are not counted.