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

Inherits:

Object

• Object
• Google::Cloud::Translate::V3::BatchTranslateDocumentMetadata

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

• #failed_characters ⇒ ::Integer

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

• #failed_pages ⇒ ::Integer

  Number of pages that failed to process in all documents so far.

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

  The state of the operation.

• #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) so far.

• #total_billable_pages ⇒ ::Integer

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

• #total_characters ⇒ ::Integer

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

• #total_pages ⇒ ::Integer

  Total number of pages to translate in all documents so far.

• #translated_characters ⇒ ::Integer

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

• #translated_pages ⇒ ::Integer

  Number of successfully translated pages in all documents so far.

Instance Attribute Details

#failed_characters ⇒ ::Integer

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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