Message クラス
IoTHub 間のメッセージを表します
メッセージの初期化子
- 継承
-
builtins.objectMessage
コンストラクター
Message(data, message_id=None, content_encoding=None, content_type=None, output_name=None)
パラメーター
名前 | 説明 |
---|---|
data
必須
|
ペイロードを構成するデータ |
message_id
|
要求/応答パターンに使用する、メッセージのユーザー設定 ID。 形式: 大文字と小文字を区別する文字列 (最大 128 文字) + ASCII 7 ビット英数字 + {'-'、':'、'.'、'+'、'%'、'_'、'#'、'*'、'?'、'!'、'('、')、','='、'@'、''、'$'、'} 既定値: None
|
content_encoding
|
メッセージ データのコンテンツ エンコード。 その他の値は utf-16 または 'utf-32' です 既定値: None
|
content_type
|
メッセージ本文でルーティングするために使用されるコンテンツ タイプ プロパティ。 既定値: None
|
output_name
|
が送信される出力の名前。 既定値: None
|
変数
名前 | 説明 |
---|---|
data
|
ペイロードを構成するデータ |
custom_properties
|
カスタム メッセージ プロパティのディクショナリ。 これらのプロパティのキーと値は常に文字列になります。 |
id
|
<xref:message>
要求/応答パターンに使用する、メッセージのユーザー設定 ID。 形式: 大文字と小文字を区別する文字列 (最大 128 文字) + ASCII 7 ビット英数字 + {'-'、':'、'.'、'+'、'%'、'_'、'#'、'*'、'?'、'!'、'('、')、','='、'@'、''、'$'、'} |
expiry_time_utc
|
メッセージの有効期限の日付と時刻 (UTC 形式) |
correlation_id
|
要求と応答のパターンで、通常は要求のmessage_idを含む応答メッセージ内の プロパティ |
user_id
|
メッセージの配信元を指定する ID |
content_encoding
|
メッセージ データのコンテンツ エンコード。 'utf-8'、'utf-16'、または 'utf-32' を指定できます |
content_type
|
メッセージ本文でメッセージをルーティングするために使用されるコンテンツ タイプ プロパティ。 'application/json' を指定できます |
output_name
|
メッセージが送信される出力の名前。 |
input_name
|
メッセージが受信された入力の名前。 |
メソッド
get_size | |
set_as_security_message |
メッセージをセキュリティ メッセージとして設定します。 これは暫定的な API です。 機能はまだ保証されていません。 |
get_size
get_size()
set_as_security_message
メッセージをセキュリティ メッセージとして設定します。
これは暫定的な API です。 機能はまだ保証されていません。
set_as_security_message()
属性
iothub_interface_id
Azure SDK for Python