JobResponse Class

JobResponse.

Inheritance

Model

JobResponse

Constructor

JobResponse(*, job_id: Optional[str] = None, query_condition: Optional[str] = None, created_time=None, start_time=None, end_time=None, max_execution_time_in_seconds: Optional[int] = None, type=None, cloud_to_device_method=None, update_twin=None, status=None, failure_reason: Optional[str] = None, status_message: Optional[str] = None, device_job_statistics=None, **kwargs)

Parameters

job_id

str

Required

System generated. Ignored at creation. The unique identifier of the job.

query_condition

str

Required

The device query condition.

created_time

datetime

Required

System generated. Ignored at creation. The creation date and time of the job.

start_time

datetime

Required

The start date and time of the scheduled job in UTC.

end_time

datetime

Required

System generated. Ignored at creation. The end date and time of the job in UTC.

max_execution_time_in_seconds

<xref:long>

Required

The maximum execution time in secounds.

type

str or <xref:protocol.models.enum>

Required

The job type. Possible values include: 'unknown', 'export', 'import', 'backup', 'readDeviceProperties', 'writeDeviceProperties', 'updateDeviceConfiguration', 'rebootDevice', 'factoryResetDevice', 'firmwareUpdate', 'scheduleDeviceMethod', 'scheduleUpdateTwin', 'restoreFromBackup', 'failoverDataCopy'

cloud_to_device_method

CloudToDeviceMethod

Required

The method type and parameters. This is required if job type is cloudToDeviceMethod.

update_twin

Twin

Required

status

str or <xref:protocol.models.enum>

Required

System generated. Ignored at creation. The status of the job. Possible values include: 'unknown', 'enqueued', 'running', 'completed', 'failed', 'cancelled', 'scheduled', 'queued'

failure_reason

str

Required

The reason for the failure, if a failure occurred.

status_message

str

Required

The status message of the job.

device_job_statistics

DeviceJobStatistics

Required

The details regarding job execution status.