azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus.yml

### YamlMime:PythonClass
uid: azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus
name: DurableOrchestrationStatus
fullName: azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus
module: azure.durable_functions.models.DurableOrchestrationStatus
inheritances:
- builtins.object
summary: 'Represents the status of a durable orchestration instance.


  Can be fetched using [[DurableOrchestrationClient]].[[get_status]].'
constructor:
  syntax: 'DurableOrchestrationStatus(name: str | None = None, instanceId: str | None
    = None, createdTime: str | None = None, lastUpdatedTime: str | None = None, input:
    Any | None = None, output: Any | None = None, runtimeStatus: OrchestrationRuntimeStatus
    | None = None, customStatus: Any | None = None, history: List[Any] | None = None,
    **kwargs)'
  parameters:
  - name: name
    defaultValue: None
  - name: instanceId
    defaultValue: None
  - name: createdTime
    defaultValue: None
  - name: lastUpdatedTime
    defaultValue: None
  - name: input
    defaultValue: None
  - name: output
    defaultValue: None
  - name: runtimeStatus
    defaultValue: None
  - name: customStatus
    defaultValue: None
  - name: history
    defaultValue: None
methods:
- uid: azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus.from_json
  name: from_json
  summary: Convert the value passed into a new instance of the class.
  signature: 'from_json(json_obj: Any)'
  parameters:
  - name: json_obj
    description: JSON object to be converted into an instance of the class
    isRequired: true
    types:
    - <xref:azure.durable_functions.models.DurableOrchestrationStatus.any>
  return:
    description: New instance of the durable orchestration status class
    types:
    - <xref:azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus>
- uid: azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus.to_json
  name: to_json
  summary: Convert object into a json dictionary.
  signature: to_json() -> Dict[str, int | str]
  return:
    description: The instance of the class converted into a json dictionary
    types:
    - <xref:typing.Dict>[<xref:str>, <xref:typing.Union>[<xref:int>, <xref:str>]]
attributes:
- uid: azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus.created_time
  name: created_time
  summary: 'Get the time at which the orchestration instance was created.


    If the orchestration instance is in the [[Pending]] status, this

    time represents the time at which the orchestration instance was

    scheduled.'
- uid: azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus.custom_status
  name: custom_status
  summary: 'Get the custom status payload (if any).


    Set by [[DurableOrchestrationContext]].[[set_custom_status]].'
- uid: azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus.history
  name: history
  summary: 'Get the execution history of the orchestration instance.


    The history log can be large and is therefore *undefined* by

    default. It is populated only when explicitly requested in the call

    to [[DurableOrchestrationClient]].[[get_status]].'
- uid: azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus.input_
  name: input_
  summary: Get the input of the orchestration instance.
- uid: azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus.instance_id
  name: instance_id
  summary: 'Get the unique ID of the instance.


    The instance ID is generated and fixed when the orchestrator

    function is scheduled. It can either auto-generated, in which case

    it is formatted as a UUID, or it can be user-specified with any

    format.'
- uid: azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus.last_updated_time
  name: last_updated_time
  summary: Get the time at which the orchestration instance last updated its execution
    history.
- uid: azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus.name
  name: name
  summary: Get the orchestrator function name.
- uid: azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus.output
  name: output
  summary: Get the output of the orchestration instance.
- uid: azure.durable_functions.models.DurableOrchestrationStatus.DurableOrchestrationStatus.runtime_status
  name: runtime_status
  summary: Get the runtime status of the orchestration instance.