СообщениеИнтеграции

Иерархия типа

graph TD;
СообщениеИнтеграции["СообщениеИнтеграции"]-->Объект["Объект"];

Сообщение, передаваемое процессом интеграции.

Сравнение ссылочное

Конструкторы

СообщениеИнтеграции

СообщениеИнтеграции(
  Параметры: ЧитаемоеСоответствие<Строка, Объект?>,
  Тело: ПотокЧтения? = Неопределено)

Создает сообщение с параметрами Параметры и телом из потока Тело. Имя параметра должно состоять из латинских букв, цифр, символов $ или _, должно начинаться с буквы.

Исключения

ИсключениеПроверкиТипа - если тип значения параметра не поддерживается. Поддерживаемые типы: * Неопределено * Строка * Число * Булево * Длительность * Момент * Байты * ЧитаемыйМассив<Объект?>, все элементы должны быть поддерживаемого типа * ЧитаемоеСоответствие<Строка, Объект?>, все значения должны быть поддерживаемого типа

ИсключениеИнтеграционнойШины - если имя параметра - пустая строка или содержит недопустимые символы.

Примеры

Пример обработчика http-запроса для программной отправки сообщения через узел типа ПрограммныйИсточник процесса интеграции с именем СетьМагазинов.

метод ОтправитьСообщение(Запрос: HttpСервисЗапрос)
    знч ЯвляетсяАрхивом = Запрос.Заголовки.ПолучитьПервый("content-type") == "application/zip"
    знч Сообщение = новый СообщениеИнтеграции({"IsArchive":ЯвляетсяАрхивом}, Запрос.Тело)
    СетьМагазинов.ОтправитьСообщениеВУзлы(Сообщение, СетьМагазинов.Схема.Узлы.ОтПартнеров)
;

Свойства

Uri

Uri в url запроса. Отличное от Неопределено значение, если сообщение получено от узлов типа Http.
Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.Uri".

АбсолютныйПутьФайла

Абсолютный путь к файлу, из которого сформировано сообщение. Отличное от Неопределено значение, если сообщение получено от узлов типа ФайлИсточник или FtpИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "File.FileAbsolutePath".

ЗапросHttp

Query в url запроса. Отличное от Неопределено значение, если сообщение получено от узлов типа Http. Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.Query".

Ид

Идентификатор сообщения.

ИменаВсехПараметров

Имена всех параметров, которые есть в сообщении.

ИмяФайла

Имя файла, из которого сформировано сообщение. Отличное от Неопределено значение, если сообщение получено от узлов типа ФайлИсточник или FtpИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "File.FileName".

КаталогФайла

Абсолютный путь к каталогу файла, из которого сформировано сообщение. Отличное от Неопределено значение, если сообщение получено от узлов типа ФайлИсточник или FtpИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "File.FileParent".

КлючKafka

Ключ входящего сообщения Kafka. Отличное от Неопределено значение, если сообщение получено от узлов типа KafkaИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "Kafka.Key".

КлючМаршрутизацииRabbitMq

Ключ маршрутизации для RabbitMq. Отличное от Неопределено значение, если сообщение получено от узлов типа RabbitMqИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "RabbitMq.RoutingKey".

КодОтветаHttp

Код ответа, который web-сервер выдал в ответ на запрос в узле типа Http. Отличное от Неопределено значение, если сообщение получено от узлов типа Http.
Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.ResponseCode".

КодировкаHttp

Кодировка, в которой web-сервер выдал ответ на запрос в узле типа Http. Отличное от Неопределено значение, если сообщение получено от узлов типа Http. Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.CharacterEncoding".

КодыПолучателей

Массив, содержащий значения кодов справочника участников, которым должно быть доставлено сообщение. Определяет, в каналы для каких получателей будет доставлено сообщение. Может быть установлено отправителем сообщения и изменено при помощи метода УстановитьКодыПолучателей.

МетодHttp

Метод запроса. Отличное от Неопределено значение, если сообщение получено от узлов типа Http. Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.Method".

ОтметкаВремениОтправкиKafka

Отметка времени отправки сообщения Kafka в формате Unix Отличное от Неопределено значение, если сообщение получено от узлов типа KafkaИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "Kafka.Timestamp".

ОтносительныйПутьФайла

Путь файла, из которого сформировано сообщение, относительно директории, заданной в свойстве Каталог узла источника. Отличное от Неопределено значение, если сообщение получено от узлов типа ФайлИсточник или FtpИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "File.FileRelativePath".

ПутьHttp

Путь в url запроса. Отличное от Неопределено значение, если сообщение получено от узлов типа Http.
Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.Path".

РазделKafka

Раздел топика Kafka, из которого получено входящее сообщение. Отличное от Неопределено значение, если сообщение получено от узлов типа KafkaИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "Kafka.Partition".

РазмерФайла

Размер файла, из которого сформировано сообщение, в байтах. Отличное от Неопределено значение, если сообщение получено от узлов типа ФайлИсточник или FtpИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "File.FileSize".

СмещениеKafka

Номер смещения входящего сообщения Kafka Отличное от Неопределено значение, если сообщение получено от узлов типа KafkaИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "Kafka.Offset".

ТекстОтветаHttp

Текст ответа, который web-сервер выдал в ответ на запрос в узле типа Http. Отличное от Неопределено значение, если сообщение получено от узлов типа Http.
Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.ResponseText".

ТекстОшибкиБд

Текст ошибки обращения к базе данных из обработчика ОбработкаСообщения узла типа Sql. Значение Неопределено, если при выполнении обработчика не было ошибки обращения к базе данных или если сообщение получено от узла другого типа.
Эквивалентно вызову метода ПолучитьПараметр с параметром "DbErrorText".

ТипСодержимогоHttp

Тип содержимого ответа, который web-сервер выдал на запрос в узле типа Http. Отличное от Неопределено значение, если сообщение получено от узлов типа Http. Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.ContentType".

ТопикKafka

Топик Kafka, из которого получено входящее сообщение. Отличное от Неопределено значение, если сообщение получено от узлов типа KafkaИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "Kafka.Topic".

ФайлИзменен

Момент модификации файла, из которого сформировано сообщение. Отличное от Неопределено значение, если сообщение получено от узлов типа ФайлИсточник или FtpИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "File.FileModified".

Методы

ПолучитьПараметр

ПолучитьПараметр(Имя: Строка): Объект?

ПолучитьПараметрИлиУмолчание

ПолучитьПараметрИлиУмолчание(
  Имя: Строка,
  Умолчание: Объект?
): Объект?

ПолучитьТелоКакПоток

ПолучитьТелоКакПоток(): ПотокЧтения

Возвращает поток для чтения тела сообщения.

СодержитПараметр

СодержитПараметр(Имя: Строка): Булево

Возвращает Истина, если сообщение содержит параметр с именем Имя, иначе Ложь.

УдалитьПараметр

УдалитьПараметр(Имя: Строка): СообщениеИнтеграции

Удаляет параметр сообщения с именем Имя. Возвращает новое сообщение.

УстановитьКодыПолучателей

УстановитьКодыПолучателей(Значение: ЧитаемыйМассив<Строка>): СообщениеИнтеграции

Устанавливает значение Значение свойства КодыПолучателей. Возвращает новое сообщение.

УстановитьПараметр

УстановитьПараметр(
  Имя: Строка,
  Значение: Объект?
): СообщениеИнтеграции

Устанавливает значение Значение параметра сообщения с именем Имя. Имя параметра должно состоять из латинских букв, цифр, символов $ или _, должно начинаться с буквы.

Исключения

ИсключениеПроверкиТипа - если тип значения Значение не поддерживается. Поддерживаемые типы: * Неопределено * Строка * Число * Булево * Длительность * Момент * Байты * ЧитаемыйМассив<Объект?>, все элементы должны быть поддерживаемого типа * ЧитаемоеСоответствие<Строка, Объект?>, все значения должны быть поддерживаемого типа

ИсключениеИнтеграционнойШины - если имя параметра - пустая строка или содержит недопустимые символы.

УстановитьТелоИзПотока

УстановитьТелоИзПотока(Поток: ПотокЧтения): СообщениеИнтеграции

Устанавливает тело сообщения из потока Поток. Возвращает новое сообщение.

Список унаследованных методов

Объект