BaggageBuilder class

Paquete:

@microsoft/agents-a365-observability

Generador de equipaje por solicitud para la propagación de contexto de OpenTelemetry.

Esta clase proporciona una API fluida para establecer valores de equipaje que se propagarán en el contexto de OpenTelemetry.

Ejemplo

const scope = new BaggageBuilder()
  .tenantId("tenant-123")
  .agentId("agent-456")
  .correlationId("corr-789")
  .build();

scope.enter();
// Baggage is set in this context
// ... do work ...
scope.exit();
// Baggage is restored after exiting the context

Métodos

agentAuid(undefined | null | string)	Establezca el valor del equipaje AUID del agente.
agentBlueprintId(undefined | null | string)	Establezca el valor del equipaje del id. de plano técnico del agente.
agentDescription(undefined | null | string)	Establezca el valor de equipaje de descripción del agente.
agentId(undefined | null | string)	Establezca el valor del equipaje del id. del agente.
agentName(undefined | null | string)	Establezca el valor del equipaje de nombre del agente.
agentUpn(undefined | null | string)	Establezca el valor del equipaje upn del agente.
build()	Aplique el equipaje recogido al contexto actual.
callerId(undefined | null | string)	Establezca el valor de equipaje del identificador de llamada.
callerName(undefined | null | string)	Establezca el valor del equipaje de nombre del autor de la llamada.
callerUpn(undefined | null | string)	Establezca el valor de equipaje UPN del autor de la llamada.
conversationId(undefined | null | string)	Establezca el valor del equipaje del identificador de conversación.
conversationItemLink(undefined | null | string)	Establezca el valor de equipaje del vínculo del artículo de conversación.
correlationId(undefined | null | string)	Establezca el valor de equipaje del identificador de correlación.
hiringManagerId(undefined | null | string)	Establezca el valor de equipaje del administrador de contratación.
operationSource(undefined | null | string)	Establezca el valor del equipaje de origen de la operación.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)	Establezca varios pares de equipaje de un diccionario o iterable.
setRequestContext(null | string, null | string, null | string)	Método de conveniencia para comenzar un ámbito de equipaje de solicitud con campos comunes.
sourceMetadataDescription(undefined | null | string)	Establezca la descripción de los metadatos de origen de ejecución (por ejemplo, descripción del canal).
sourceMetadataId(undefined | null | string)	Establezca el identificador de metadatos de origen de ejecución (por ejemplo, identificador de canal).
sourceMetadataName(undefined | null | string)	Establezca el nombre de metadatos de origen de ejecución (por ejemplo, nombre del canal).
tenantId(undefined | null | string)	Establezca el valor de equipaje del identificador de inquilino.

Detalles del método

agentAuid(undefined | null | string)

Establezca el valor del equipaje AUID del agente.

function agentAuid(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

AuID del agente

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

agentBlueprintId(undefined | null | string)

Establezca el valor del equipaje del id. de plano técnico del agente.

function agentBlueprintId(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Identificador del plano técnico del agente

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

agentDescription(undefined | null | string)

Establezca el valor de equipaje de descripción del agente.

function agentDescription(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Descripción del agente

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

agentId(undefined | null | string)

Establezca el valor del equipaje del id. del agente.

function agentId(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

El ID de agente

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

agentName(undefined | null | string)

Establezca el valor del equipaje de nombre del agente.

function agentName(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Nombre del agente

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

agentUpn(undefined | null | string)

Establezca el valor del equipaje upn del agente.

function agentUpn(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

UpN del agente

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

build()

Aplique el equipaje recogido al contexto actual.

function build(): BaggageScope

Devoluciones

BaggageScope

Administrador de contexto que restaura el equipaje anterior al salir

callerId(undefined | null | string)

Establezca el valor de equipaje del identificador de llamada.

function callerId(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Identificador del autor de la llamada

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

callerName(undefined | null | string)

Establezca el valor del equipaje de nombre del autor de la llamada.

function callerName(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Nombre del autor de la llamada

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

callerUpn(undefined | null | string)

Establezca el valor de equipaje UPN del autor de la llamada.

function callerUpn(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Upn del autor de la llamada

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

conversationId(undefined | null | string)

Establezca el valor del equipaje del identificador de conversación.

function conversationId(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Identificador de conversación

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

conversationItemLink(undefined | null | string)

Establezca el valor de equipaje del vínculo del artículo de conversación.

function conversationItemLink(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Vínculo del elemento de conversación

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

correlationId(undefined | null | string)

Establezca el valor de equipaje del identificador de correlación.

function correlationId(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Identificador de correlación

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

hiringManagerId(undefined | null | string)

Establezca el valor de equipaje del administrador de contratación.

function hiringManagerId(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Identificador del administrador de contratación

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

operationSource(undefined | null | string)

Establezca el valor del equipaje de origen de la operación.

function operationSource(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Valor de origen de la operación

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)

Establezca varios pares de equipaje de un diccionario o iterable.

function setPairs(pairs: undefined | null | Record<string, any> | Iterable<[string, any]>): BaggageBuilder

Parámetros

pairs

undefined | null | Record<string, any> | Iterable<[string, any]>

Diccionario o iterable de pares clave-valor

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

setRequestContext(null | string, null | string, null | string)

Método de conveniencia para comenzar un ámbito de equipaje de solicitud con campos comunes.

static function setRequestContext(tenantId?: null | string, agentId?: null | string, correlationId?: null | string): BaggageScope

Parámetros

tenantId

null | string

Identificador de inquilino

agentId

null | string

El ID de agente

correlationId

null | string

Identificador de correlación

Devoluciones

BaggageScope

Administrador de contexto que restaura el equipaje anterior al salir

sourceMetadataDescription(undefined | null | string)

Establezca la descripción de los metadatos de origen de ejecución (por ejemplo, descripción del canal).

function sourceMetadataDescription(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Descripción de los metadatos de origen

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

sourceMetadataId(undefined | null | string)

Establezca el identificador de metadatos de origen de ejecución (por ejemplo, identificador de canal).

function sourceMetadataId(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Identificador de metadatos de origen

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

sourceMetadataName(undefined | null | string)

Establezca el nombre de metadatos de origen de ejecución (por ejemplo, nombre del canal).

function sourceMetadataName(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Nombre de metadatos de origen

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos

tenantId(undefined | null | string)

Establezca el valor de equipaje del identificador de inquilino.

function tenantId(value: undefined | null | string): BaggageBuilder

Parámetros

value

undefined | null | string

Identificador de inquilino

Devoluciones

BaggageBuilder

Auto para el encadenamiento de métodos