BaggageBuilder class
OpenTelemetry コンテキスト伝達の要求手荷物ビルダーごと。
このクラスは、OpenTelemetry コンテキストで伝達される手荷物の値を設定するための fluent API を提供します。
例
const scope = new BaggageBuilder()
.tenantId("tenant-123")
.agentId("agent-456")
.build();
scope.enter();
// Baggage is set in this context
// ... do work ...
scope.exit();
// Baggage is restored after exiting the context
メソッド
メソッドの詳細
agentAuid(string | null | undefined)
エージェント AUID 手荷物の値を設定します。
function agentAuid(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
エージェント AUID
戻り値
メソッド チェーン用の自己
agentBlueprintId(string | null | undefined)
エージェントのブループリント ID 手荷物の値を設定します。
function agentBlueprintId(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
エージェントブループリント ID
戻り値
メソッド チェーン用の自己
agentDescription(string | null | undefined)
エージェントの説明の手荷物の値を設定します。
function agentDescription(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
エージェントの説明
戻り値
メソッド チェーン用の自己
agentEmail(string | null | undefined)
エージェントのメール手荷物の値を設定します。
function agentEmail(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
エージェントの電子メール
戻り値
メソッド チェーン用の自己
agentId(string | null | undefined)
エージェント ID の手荷物の値を設定します。
function agentId(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
エージェントの ID
戻り値
メソッド チェーン用の自己
agentName(string | null | undefined)
エージェント名の手荷物の値を設定します。
function agentName(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
エージェント名
戻り値
メソッド チェーン用の自己
agentPlatformId(string | null | undefined)
エージェント プラットフォーム ID の手荷物の値を設定します。
function agentPlatformId(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
エージェント プラットフォーム ID
戻り値
メソッド チェーン用の自己
agentVersion(string | null | undefined)
エージェントバージョンの手荷物の値を設定します。
function agentVersion(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
エージェントのバージョン (例: '1.0.0'、'2025-05-01')
戻り値
メソッド チェーン用の自己
build()
callerAgentPlatformId(string | null | undefined)
発信者エージェントのプラットフォーム ID 手荷物の値を設定します。
function callerAgentPlatformId(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
呼び出し元エージェント のプラットフォーム識別子
戻り値
メソッド チェーン用の自己
callerClientIp(string | null | undefined)
呼び出し元クライアントの IP 手荷物の値を設定します。 OpenTelemetry 手荷物を介して伝達できるように、要求の送信元クライアント IP をキャプチャするために使用されます。
function callerClientIp(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
呼び出し元クライアントの IP アドレス
戻り値
メソッド チェーン用の自己
channelLink(string | null | undefined)
チャネル リンク/URL を設定します。
function channelLink(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
チャネル リンク
戻り値
メソッド チェーン用の自己
channelName(string | null | undefined)
チャネル名 (Teams、Slack など) を設定します。
function channelName(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
チャネル名
戻り値
メソッド チェーン用の自己
conversationId(string | null | undefined)
会話 ID の手荷物の値を設定します。
function conversationId(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
会話 ID
戻り値
メソッド チェーン用の自己
conversationItemLink(string | null | undefined)
会話項目リンク手荷物の値を設定します。
function conversationItemLink(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
会話アイテムのリンク
戻り値
メソッド チェーン用の自己
invokeAgentServer(string | null | undefined, number)
呼び出しエージェント のサーバー アドレスとポート手荷物の値を設定します。
function invokeAgentServer(address: string | null | undefined, port?: number): BaggageBuilder
パラメーター
- address
-
string | null | undefined
ターゲット エージェント サービスのサーバー アドレス (ホスト名)。
- port
-
number
オプションのサーバー ポート。 443 と異なる場合にのみ記録されます。
戻り値
メソッドチェーンの現在のビルダー インスタンス。
operationSource(string | null | undefined)
操作ソースの手荷物の値を設定します。 サービスを識別するためにサーバー スパン (ATG、ACF など) に使用されます。
function operationSource(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
操作ソース
戻り値
メソッド チェーン用の自己
sessionDescription(string | null | undefined)
セッションの説明の手荷物の値を設定します。
function sessionDescription(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
セッションの説明
戻り値
メソッド チェーン用の自己
sessionId(string)
セッション ID の手荷物の値を設定します。
function sessionId(value: string): BaggageBuilder
パラメーター
- value
-
string
セッション ID
戻り値
メソッド チェーン用の自己
setPairs(Record<string, any> | Iterable<[string, any], any, any> | null | undefined)
辞書または iterable から複数の手荷物ペアを設定します。
function setPairs(pairs: Record<string, any> | Iterable<[string, any], any, any> | null | undefined): BaggageBuilder
パラメーター
- pairs
-
Record<string, any> | Iterable<[string, any], any, any> | null | undefined
キーと値のペアのディクショナリまたはイターブル
戻り値
メソッド チェーン用の自己
setRequestContext(string | null, string | null)
共通フィールドを使用して手荷物の範囲を要求する便利な方法。
static function setRequestContext(tenantId?: string | null, agentId?: string | null): BaggageScope
パラメーター
- tenantId
-
string | null
テナント ID
- agentId
-
string | null
エージェントの ID
戻り値
出口で前の手荷物を復元するコンテキスト マネージャー
tenantId(string | null | undefined)
テナント ID の手荷物の値を設定します。
function tenantId(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
テナント ID
戻り値
メソッド チェーン用の自己
userEmail(string | null | undefined)
ユーザーのメール手荷物の値を設定します。
function userEmail(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
ユーザーの電子メール
戻り値
メソッド チェーン用の自己
userId(string | null | undefined)
ユーザー ID の手荷物の値を設定します。
function userId(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
ユーザー ID
戻り値
メソッド チェーン用の自己
userName(string | null | undefined)
ユーザー名の手荷物の値を設定します。
function userName(value: string | null | undefined): BaggageBuilder
パラメーター
- value
-
string | null | undefined
ユーザー名
戻り値
メソッド チェーン用の自己