JobResponse クラス

  • リファレンス

JobResponse。

継承
Model
JobResponse

コンストラクター

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

パラメーター

job_id
str
必須

システムが生成されました。 作成時に無視されます。 ジョブの一意識別子。

query_condition
str
必須

デバイス のクエリ条件。

created_time
datetime
必須

システムが生成されました。 作成時に無視されます。 ジョブの作成日時。

start_time
datetime
必須

スケジュールされたジョブの開始日時 (UTC)。

end_time
datetime
必須

システムが生成されました。 作成時に無視されます。 ジョブの終了日時 (UTC)。

max_execution_time_in_seconds
<xref:long>
必須

秒単位の最大実行時間。

type
str または <xref:protocol.models.enum>
必須

ジョブの種類。 指定できる値は、'unknown'、'export'、'import'、'backup'、'readDeviceProperties'、'writeDeviceProperties'、'updateDeviceConfiguration'、'rebootDevice'、'factoryResetDevice'、'firmwareUpdate'、'scheduleDeviceMethod'、'scheduleUpdateTwin'、'restoreFromBackup'、'failoverDataCopy' です。

cloud_to_device_method
CloudToDeviceMethod
必須

メソッドの型とパラメーター。 これは、ジョブの種類が cloudToDeviceMethod の場合に必要です。

update_twin
Twin
必須
status
str または <xref:protocol.models.enum>
必須

システムが生成されました。 作成時に無視されます。 ジョブの状態。 使用可能な値は、'unknown'、'enqueued'、'running'、'completed'、'failed'、'cancelled'、'scheduled'、'queued' です。

failure_reason
str
必須

エラーが発生した場合のエラーの理由。

status_message
str
必須

ジョブの状態メッセージ。

device_job_statistics
DeviceJobStatistics
必須

ジョブの実行状態に関する詳細。

メソッド

as_dict

json.dump を使用して JSONify できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。

このファイルの 3 つの例を参照してください。

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。
deserialize

RestAPI 構文を使用して str を解析し、モデルを返します。
enable_additional_properties_sending
from_dict

指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。

既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、last_rest_key_case_insensitive_extractor) を検討してください
is_xml_model
serialize

このモデルから Azure に送信される JSON を返します。

これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです。

XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。
validate

このモデルを再帰的に検証し、ValidationError の一覧を返します。

as_dict

json.dump を使用して JSONify できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。

このファイルの 3 つの例を参照してください。

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

パラメーター

key_transformer
<xref:function>

キー トランスフォーマー関数。

keep_readonly
既定値: True

戻り値

dict JSON 互換オブジェクト

の戻り値の型 :

dict

deserialize

RestAPI 構文を使用して str を解析し、モデルを返します。

deserialize(data, content_type=None)

パラメーター

data
str
必須

RestAPI 構造体を使用する str。 既定では JSON。

content_type
str
既定値: None

JSON は既定で、application/xml if XML を設定します。

戻り値

このモデルのインスタンス

例外

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。

既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、last_rest_key_case_insensitive_extractor) を検討してください

from_dict(data, key_extractors=None, content_type=None)

パラメーター

data
dict
必須

RestAPI 構造体を使用したディクテーション

content_type
str
既定値: None

JSON は既定で、application/xml if XML を設定します。

key_extractors
既定値: None

戻り値

このモデルのインスタンス

例外

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

このモデルから Azure に送信される JSON を返します。

これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです。

XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。

serialize(keep_readonly=False, **kwargs)

パラメーター

keep_readonly
bool
既定値: False

readonly 属性をシリアル化する場合

戻り値

dict JSON 互換オブジェクト

の戻り値の型 :

dict

validate

このモデルを再帰的に検証し、ValidationError の一覧を返します。

validate()

戻り値

検証エラーの一覧

の戻り値の型 :

list