Class: Google::Cloud::Translate::V3::BatchTranslateDocumentMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/translate/v3/translation_service.rb

Overview

State metadata for the batch translation operation.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#failed_characters ⇒ ::Integer

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



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1603

class BatchTranslateDocumentMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the job.
  module State
    # Invalid.
    STATE_UNSPECIFIED = 0

    # Request is being processed.
    RUNNING = 1

    # The batch is processed, and at least one item was successfully processed.
    SUCCEEDED = 2

    # The batch is done and no item was successfully processed.
    FAILED = 3

    # Request is in the process of being canceled after caller invoked
    # longrunning.Operations.CancelOperation on the request id.
    CANCELLING = 4

    # The batch is done after the user has called the
    # longrunning.Operations.CancelOperation. Any records processed before the
    # cancel command are output as specified in the request.
    CANCELLED = 5
  end
end

#failed_pages ⇒ ::Integer

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



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1603

class BatchTranslateDocumentMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the job.
  module State
    # Invalid.
    STATE_UNSPECIFIED = 0

    # Request is being processed.
    RUNNING = 1

    # The batch is processed, and at least one item was successfully processed.
    SUCCEEDED = 2

    # The batch is done and no item was successfully processed.
    FAILED = 3

    # Request is in the process of being canceled after caller invoked
    # longrunning.Operations.CancelOperation on the request id.
    CANCELLING = 4

    # The batch is done after the user has called the
    # longrunning.Operations.CancelOperation. Any records processed before the
    # cancel command are output as specified in the request.
    CANCELLED = 5
  end
end

#state ⇒ ::Google::Cloud::Translate::V3::BatchTranslateDocumentMetadata::State

Returns The state of the operation.

Returns:



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1603

class BatchTranslateDocumentMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the job.
  module State
    # Invalid.
    STATE_UNSPECIFIED = 0

    # Request is being processed.
    RUNNING = 1

    # The batch is processed, and at least one item was successfully processed.
    SUCCEEDED = 2

    # The batch is done and no item was successfully processed.
    FAILED = 3

    # Request is in the process of being canceled after caller invoked
    # longrunning.Operations.CancelOperation on the request id.
    CANCELLING = 4

    # The batch is done after the user has called the
    # longrunning.Operations.CancelOperation. Any records processed before the
    # cancel command are output as specified in the request.
    CANCELLED = 5
  end
end

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

Returns Time when the operation was submitted.

Returns:



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1603

class BatchTranslateDocumentMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the job.
  module State
    # Invalid.
    STATE_UNSPECIFIED = 0

    # Request is being processed.
    RUNNING = 1

    # The batch is processed, and at least one item was successfully processed.
    SUCCEEDED = 2

    # The batch is done and no item was successfully processed.
    FAILED = 3

    # Request is in the process of being canceled after caller invoked
    # longrunning.Operations.CancelOperation on the request id.
    CANCELLING = 4

    # The batch is done after the user has called the
    # longrunning.Operations.CancelOperation. Any records processed before the
    # cancel command are output as specified in the request.
    CANCELLED = 5
  end
end

#total_billable_characters ⇒ ::Integer

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



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1603

class BatchTranslateDocumentMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the job.
  module State
    # Invalid.
    STATE_UNSPECIFIED = 0

    # Request is being processed.
    RUNNING = 1

    # The batch is processed, and at least one item was successfully processed.
    SUCCEEDED = 2

    # The batch is done and no item was successfully processed.
    FAILED = 3

    # Request is in the process of being canceled after caller invoked
    # longrunning.Operations.CancelOperation on the request id.
    CANCELLING = 4

    # The batch is done after the user has called the
    # longrunning.Operations.CancelOperation. Any records processed before the
    # cancel command are output as specified in the request.
    CANCELLED = 5
  end
end

#total_billable_pages ⇒ ::Integer

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



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1603

class BatchTranslateDocumentMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the job.
  module State
    # Invalid.
    STATE_UNSPECIFIED = 0

    # Request is being processed.
    RUNNING = 1

    # The batch is processed, and at least one item was successfully processed.
    SUCCEEDED = 2

    # The batch is done and no item was successfully processed.
    FAILED = 3

    # Request is in the process of being canceled after caller invoked
    # longrunning.Operations.CancelOperation on the request id.
    CANCELLING = 4

    # The batch is done after the user has called the
    # longrunning.Operations.CancelOperation. Any records processed before the
    # cancel command are output as specified in the request.
    CANCELLED = 5
  end
end

#total_characters ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1603

class BatchTranslateDocumentMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the job.
  module State
    # Invalid.
    STATE_UNSPECIFIED = 0

    # Request is being processed.
    RUNNING = 1

    # The batch is processed, and at least one item was successfully processed.
    SUCCEEDED = 2

    # The batch is done and no item was successfully processed.
    FAILED = 3

    # Request is in the process of being canceled after caller invoked
    # longrunning.Operations.CancelOperation on the request id.
    CANCELLING = 4

    # The batch is done after the user has called the
    # longrunning.Operations.CancelOperation. Any records processed before the
    # cancel command are output as specified in the request.
    CANCELLED = 5
  end
end

#total_pages ⇒ ::Integer

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



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1603

class BatchTranslateDocumentMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the job.
  module State
    # Invalid.
    STATE_UNSPECIFIED = 0

    # Request is being processed.
    RUNNING = 1

    # The batch is processed, and at least one item was successfully processed.
    SUCCEEDED = 2

    # The batch is done and no item was successfully processed.
    FAILED = 3

    # Request is in the process of being canceled after caller invoked
    # longrunning.Operations.CancelOperation on the request id.
    CANCELLING = 4

    # The batch is done after the user has called the
    # longrunning.Operations.CancelOperation. Any records processed before the
    # cancel command are output as specified in the request.
    CANCELLED = 5
  end
end

#translated_characters ⇒ ::Integer

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



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1603

class BatchTranslateDocumentMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the job.
  module State
    # Invalid.
    STATE_UNSPECIFIED = 0

    # Request is being processed.
    RUNNING = 1

    # The batch is processed, and at least one item was successfully processed.
    SUCCEEDED = 2

    # The batch is done and no item was successfully processed.
    FAILED = 3

    # Request is in the process of being canceled after caller invoked
    # longrunning.Operations.CancelOperation on the request id.
    CANCELLING = 4

    # The batch is done after the user has called the
    # longrunning.Operations.CancelOperation. Any records processed before the
    # cancel command are output as specified in the request.
    CANCELLED = 5
  end
end

#translated_pages ⇒ ::Integer

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



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 1603

class BatchTranslateDocumentMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State of the job.
  module State
    # Invalid.
    STATE_UNSPECIFIED = 0

    # Request is being processed.
    RUNNING = 1

    # The batch is processed, and at least one item was successfully processed.
    SUCCEEDED = 2

    # The batch is done and no item was successfully processed.
    FAILED = 3

    # Request is in the process of being canceled after caller invoked
    # longrunning.Operations.CancelOperation on the request id.
    CANCELLING = 4

    # The batch is done after the user has called the
    # longrunning.Operations.CancelOperation. Any records processed before the
    # cancel command are output as specified in the request.
    CANCELLED = 5
  end
end