Skip to content

Latest commit

 

History

History
37 lines (32 loc) · 3.67 KB

File metadata and controls

37 lines (32 loc) · 3.67 KB

Task

The task resource provides information about progress of asynchronous request processing and is where associated resources can be found.

Properties

Name Type Description Notes
customer_id str The customer application identifier [optional] [readonly]
generation int A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date. [optional] [readonly]
id str An identifier for the resource, usually a UUID. [optional] [readonly]
name str A system specified name for the resource. [optional]
resource_uri str The 'self' reference for this resource. [optional] [readonly]
type str The type of resource. [optional] [readonly]
additional_details TaskPropertiesAdditionalDetails [optional]
associated_resources [ResourceReference] Resources that are associated with the task. These may be created by the task or other resources that are involved in the task. [optional]
child_tasks [ResourceReference] A list of sub-tasks that were initiated by this task. [optional]
created_at datetime The time this task was created. [optional]
display_name str The displayed name for the task. [optional]
ended_at datetime, none_type The time this task completed. [optional]
error TaskPropertiesError [optional]
estimated_running_duration_minutes int An estimate of how long the task will run before completing. [optional]
health_status str The health status indicates if any errors or problems have been encountered during the processing of the task. Expected values are OK, ERROR, WARNING, UNKNOWN, and UNSPECIFIED. [optional]
log_messages [TaskLogMessage] Time stamped messages that record the progress of the task. [optional]
parent_task TaskPropertiesParentTask [optional]
progress_percent int A percentage representation of progress to completion. [optional]
recommendations [TaskRecommendations] Recommendations on how to fix failing tasks. [optional]
source_resource TaskPropertiesSourceResource [optional]
started_at datetime, none_type The time this task was started. [optional]
state str A message to indicate the current state of the task, for example the current step in a workflow. Expected values are INITIALIZED, RUNNING, FAILED, SUCCEEDED, TIMEDOUT, PAUSED, and UNSPECIFIED. [optional]
suggested_polling_interval_seconds int This attribute suggests a suitable interval to use when polling for progress. Where specified this will be based on the frequency with which the task is likely to be updated. [optional]
updated_at datetime, none_type The time this task was last updated. [optional]
user_id str The ID or email address of the user that initiated the task. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]