Share via

DocumentStatus Class

Document Status Response.

Constructor

DocumentStatus(*args: Any, **kwargs: Any)

Variables

Name Description
translated_document_url
str

Location of the document or folder.
source_document_url
str

Location of the source document. Required.
created_on
datetime

Operation created date time. Required.
last_updated_on
datetime

Date time in which the operation's status has been updated. Required.
status
str or Status

List of possible statuses for job or document. Required. Known values are: "NotStarted", "Running", "Succeeded", "Failed", "Cancelled", "Cancelling", and "ValidationFailed".
translated_to
str

To language. Required.
error
DocumentTranslationError

This contains an outer error with error code, message, details, target and an inner error with more descriptive details.
translation_progress
float

Progress of the translation if available. Required.
id
str

Document Id. Required.
characters_charged
int

Character charged by the API.

Methods

as_dict

Return a dict that can be turned into json using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear 

clear() -> None

copy 

copy() -> Model

get 

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

keys 

keys() -> KeysView[str]

pop 

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem 

popitem() -> Tuple[str, Any]

setdefault 

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Attributes

characters_charged

Character charged by the API.

characters_charged: int | None

created_on

Operation created date time. Required.

created_on: datetime

error

This contains an outer error with error code, message, details, target and an inner error with more descriptive details.

error: _models.DocumentTranslationError | None

id

Document Id. Required.

id: str

last_updated_on

Date time in which the operation's status has been updated. Required.

last_updated_on: datetime

source_document_url

Location of the source document. Required.

source_document_url: str

status

"NotStarted", "Running", "Succeeded", "Failed", "Cancelled", "Cancelling", and "ValidationFailed".

status: str | _models.Status

translated_document_url

Location of the document or folder.

translated_document_url: str | None

translated_to

To language. Required.

translated_to: str

translation_progress

Progress of the translation if available. Required.

translation_progress: float