@ cummulus/ 消息

用于构建和解析 Cumulus 工作流程信息的公用事业.

使用量

  npm install @cumulus/message

API 密码

模块

构建

用于构建 Cumulus 消息的功能

处决

生成执行信息或解析执行信息的实用功能 从 Cumulus 信件中

颗粒

从 Cumulus 信件解析颗粒信息的功能

队列

从 Cumulus 消息解析队列信息的功能

职能

获取MessageAsync OperationId(消息) ⇒ undefined | string ⏏

从工作流程消息中获取同步操作ID, 如果有的话.

构造 CollectionId( 名称, 版本) ⇒ string ⏏

返回收藏 ID.

已解构 CollectionId( 收藏) (d) 国家 ⇒

返回基于 用于弹性搜索索引的收藏Id

从信件( 消息) 中获取集合Name ⇒ CollectionInfo | undefined ⏏

从执行消息中获取收藏名称和版本 .

获取从邮件( 消息) 中收集信息 ⇒ string | undefined ⏏

从执行消息中获取收藏ID.

isCumulusMessage Like( ) 语句

检查 CumulusMessage 形状

isDLQ记录类似( )

SQS 信件形状的空格检查

解围信库Message ()

解开已死字母 Cumulus 消息,可能用 国家云表活动,包含在SQS信息中.

提取SQSMetata(消息) ⇒

从 SQS(/DLQ) 记录中剥取元数据

升起CumulusMessageDetails () (中文(简体) )

Reformat 有顶级密钥属性的对象.

获取MessagePdr(消息) ⇒ undefined | Object ⏏

从工作流程信息中获取 PDR 对象, 如果有的话.

信件HasPdr( 消息) ⇒ boolean ⏏

确定信件是否有 PDR .

获取MessagePdrPANSent(消息) ⇒ boolean ⏏

从工作流程信息中获取 PAN 发送状态, 如果有的话 .

获取MessagePdrPANMessage(消息) ⇒ string ⏏

从工作流程消息中获取 PAN 消息状态, 如果有的话 .

获取MessagePdrName(消息) ⇒ string ⏏

从工作流程信息中获取 PDR 名称, 如果有的话.

获取MessagePdrRunning 执行(消息) ⇒ number ⏏

如果有的话,请提供共和国执行处决的次数.

获得MessagePdr 完成执行(消息) ⇒ number ⏏

如果有的话,请提供共和国的死刑数量.

获取MessagePdrFlied Executions( 消息) ⇒ number ⏏

获取一个共和国的死刑失败数.

获取MessagePdrStats(消息) ⇒ PdrStats ⏏

把PDR数据从工作流程信息中调出来.

获取 PdrPercent 完成( 数据) ⇒ number ⏏

完成共和国处决的百分比

生成 PdrApi 从Message( 消息, 更新At) 记录 ⇒ ApiPdr ⏏

从消息中生成 PDR API 记录 .

获取消息 ⇒ MessageProvider | string ⏏

把供应商从工作流程信息中调出来.

获取消息 ⇒ undefined | string ⏏

从工作流程消息中获取提供者的ID, 如果有的话.

牵引StepFunfunctionEvent(事件) ⇒ Promise.<object> ⏏

设定一个步骤函数事件, 将指定的密钥替换为内容 s3 远程信件

剖析步骤( stepMessage, step)Name ⇒ Promise.<object> ⏏

用 CMA 密钥解析步骤消息, 并替换指定密钥, 如果有内容的话 s3 远程信件

获取失败的StepName (事件, 失败的StepEvent) ⇒ string

搜索与任务国相关的执行步骤历史 失败的任务 ID。 HistoryEvent ids 依次编号,开始于 一个.

上次失败的晚会Step( 事件) ⇒ Array.<HistoryEvent> | undefined

查找所有失败的执行事件并返回列表中的最后一个事件 . 寻找失败的 Lambda 处决( Lambda Function Fault) , 失败的 ECS 任务( 任务失败) 或外部工人( 活动失败)

获取失败ExecutionMessage( 输入CumulusMessage, 获取ExecutionHistory Function) 命令 ⇒ Object

获取消息用于发布失败的执行通知 .

尝试获取执行中最后一个失败步骤的输入, 这样我们就可以 更新初始执行中不存在的任何颗粒/ PDR 状态 输入.

回到总体执行投入.

是FileExtension Matched(granuleFile,扩展名) ⇒ boolean

检查文件是否有扩展名

解析例外( 例外) ⇒ string

确保例外作为对象返回

获取气象状态( 消息) ⇒ Message.WorkflowStatus | undefined ⏏

获取工作流程消息的状态, 如果有的话 .

获取 MessageWorkflow 任务(消息) ⇒ Object | undefined ⏏

在工作流程信息中获取工作流程任务, 如果有的话 .

获取 MessageWorkflows 开始时间(消息) ⇒ number | undefined ⏏

如果有工作流程启动时间的话.

获得MessageWorkflow 停止时间(消息) ⇒ number | undefined ⏏

让工作流程停止时间,如果有的话.

获取MessageWorkflowName(消息) ⇒ string | undefined ⏏

获取工作流程名称,如果有的话.

获得工作流程定义( 开始时间, [停止时间]) ⇒ number ⏏

获取工作流程的持续时间 .

构建

用于构建 Cumulus 消息的功能

示例

const Build = require('@cumulus/message/Build');

构建来自Template( params) @ @ @ info Message.CumulusMessage ⏏

从工作流程模板中创建用于排队执行的 SQS 消息 .

仁爱: 导出函数 回返数字 : Message.CumulusMessage - Cumulus 信件对象

处决

生成执行信息或解析执行信息的实用功能 从 Cumulus 信件中

示例

const Executions = require('@cumulus/message/Executions');

• 处决
  • 构建ExecutionArn( 状态 MachineArn, 执行Name ⇒ string ⏏
  • 获取Execution UrlFromArn( 执行) ⇒ string ⏏
  • 获取 State MachineArn FromExecutionArn( 执行 ) ⇒ string ⏏
  • 获取MessageExecutionName(消息) ⇒ string ⏏
  • 获取Message State MachineArn( 消息) ⇒ string ⏏
  • 获取MessageExecutionArn(消息) ⇒ null | string ⏏
  • 获取信息 ⇒ undefined | string ⏏
  • 获取MessageCumulusVersion(消息) ⇒ undefined | string ⏏
  • 获得Message Execution 原始文件 ⇒ unknown | undefined ⏏
  • 获取Message Execution 页面存档备份,存于互联网档案馆 ⇒ unknown | undefined ⏏
  • 生成ExecumentApi Record fromMessage(消息,[更新At]) ⇒ ApiExecution ⏏
  • 全球
    • 生成 PdrApi 从Message( 消息, 更新At) 记录 ⇒ ApiPdr ⏏

建立ExecutionArn( State MachineArn, executionName) QQ string ⏏

从状态机器 ARN 构建执行 ARN 和执行名

仁爱: 导出函数 回返数字 : string - 处决ARN

获取Execution UrlFromArn( ExecutionArn) QQ string ⏏

从执行 ARN 返回执行 URL.

仁爱: 导出函数 回返数字 : string - 返回执行时的 AWS 控制台 URL

获取 State MachineArn FromExecution Arn (ExecutionArn) string ⏏

从处决中获取状态机器ARN ARN

仁爱: 导出函数 回返数字 : string - 国家机器ARN

获取Message ExecutionName (消息) QQ string ⏏

从工作流程消息中获取执行名称 .

仁爱: 导出函数 回返数字 : string - 一个行刑名 掷出数字 :

• Error 如果没有执行名称

获得Message State MachineArn(信息) {} string ⏏

从工作流程信息中获取状态机器ARN.

仁爱: 导出函数 回返数字 : string - 国家机器ARN 掷出数字 :

• Error 如果没有国家机器ARN

获取Message ExecutionArn( 消息) QQ null | string ⏏

从工作流程消息中获取执行 ARN.

仁爱: 导出函数 回返数字 : null | string - 国家机器处决ARN

获得Message Execution 父母(消息) QQ undefined | string ⏏

从工作流程消息中获取父执行 ARN, 如果有的话.

仁爱: 导出函数 回返数字 : undefined | string - 国家机器处决ARN

获取MessageCumulusVersion(消息) {} undefined | string ⏏

从工作流程信息中获取 Cumulus 版本, 如果有的话 .

仁爱: 导出函数 回返数字 : undefined | string - 积分版

获取Message Execution 原始的Payload( 消息) QQ unknown | undefined ⏏

获取工作流程原始载荷,如果有的话.

仁爱: 导出函数 回返数字 : unknown | undefined - 工作流程原始有效载荷

获取Message Execution FinalPayload( 消息) QQ unknown | undefined ⏏

得到工作流程最后有效载荷,如果有的话.

仁爱: 导出函数 回返数字 : unknown | undefined - 工作流程最后有效载荷

生成 ExecutionApi Record fromMessage(消息,[更新At]) QQ ApiExecution ⏏

从消息中生成 API 的执行记录 .

仁爱: 导出函数 回返数字 : ApiExecution - 处决API记录

生成 PdrApi Record fromMessage( 消息, [更新At]) QQ ApiPdr ⏏

从消息中生成 PDR API 记录 .

仁爱:全球方法 Executions 回返数字 : ApiPdr - PDR API记录

颗粒

从 Cumulus 信件解析颗粒信息的功能

示例

const Granules = require('@cumulus/message/Granules');

• 颗粒
  • 获取MessageGranules(消息) ⇒ Array.<object> | undefined ⏏
  • 信件( 消息) ⇒ boolean ⏏
  • granule 状态( 工作流程状态, 颗粒) ⇒ string ⏏
  • 获取 Granule 查询字段( 消息) ⇒ unknown | undefined ⏏
  • 生成 GranuleApi 记录( 消息) ⇒ Promise.<ApiGranule> ⏏

获取Message Granules(消息) {} Array.<object> | undefined ⏏

从有效载荷中取出颗粒.

仁爱: 导出函数 回返数字 : Array.<object> | undefined - 颗粒物阵列,或 未定义如果 message.payload.granules 未设置

信件 HasGranules( 消息) QQ boolean ⏏

确定信件是否有颗粒对象 .

仁爱: 导出函数 回返数字 : boolean - 如果信件有颗粒对象, 则为真

granule 状态( 工作流程状态, 颗粒) QQ string ⏏

确定颗粒的状态.

仁爱: 导出函数 回返数字 : string - 颗粒状态

获取 Granule 查询字段( 消息) QQ unknown | undefined ⏏

获取颗粒的查询字段, 如果有的话

仁爱: 导出函数 回返数字 : unknown | undefined - 颗粒查询字段,如果有的话

生成 GranuleApi 记录( 消息) QQ Promise.<ApiGranule> ⏏

生成 API 颗粒记录

仁爱: 导出函数 回返数字 : Promise.<ApiGranule> - 颗粒API记录

队列

从 Cumulus 消息解析队列信息的功能

示例

const Queue = require('@cumulus/message/Queue');

• 队列
  • 获取QueeUrl( 消息) ⇒ string ⏏
  • 获取 Maximum 执行( 消息, 队列Url) ⇒ number ⏏
  • 有队列和ExecutionLimit(消息) ⇒ boolean ⏏

获取QueeUrl( 消息) QQ string ⏏

从工作流程消息中获取队列 URL .

仁爱: 导出函数 回返数字 : string - 队列 URL

获取 Maximum Executions( 消息, 队列Url) QQ number ⏏

排队的死刑最多.

仁爱: 导出函数 回返数字 : number - 排队的最大处决数 掷出数字 :

• Error 如果无法找到最大限度的处决

有 QueetAndExecutionLimit(消息) QQ boolean ⏏

确定消息中是否有队列和队列执行限制 .

仁爱: 导出函数 回返数字 : boolean - 如果有排队和执行限制,则属实.

isCumulusMessage Like( ) 语句

检查 CumulusMessage 形状

仁爱:全球职能

isDLQ记录类似( )

SQS 信件形状的空格检查

仁爱:全球职能

解围信库Message ()

解开已死字母 Cumulus 消息,可能用 国家云表活动,包含在SQS信息中.

仁爱:全球职能

提取 SQSMetata( 消息) QQ

从 SQS(/DLQ) 记录中剥取元数据

仁爱:全球职能 回返: 没有正文的给定信息

升起CumulusMessageDetails () (中文(简体) )

Reformat 有顶级密钥属性的对象.

仁爱:全球职能

获得失败的 StepName (事件, 失败的 StepEvent) % string

搜索与任务国相关的执行步骤历史 失败的任务 ID。 HistoryEvent ids 依次编号,开始于 一个.

仁爱:全球职能 回返数字 : string - 当前继函数任务的名称或“ 未知失败步骤Name.

上次失败的EventStep( 事件) QQ Array.<HistoryEvent> | undefined

查找所有失败的执行事件并返回列表中的最后一个事件 . 寻找失败的 Lambda 处决( Lambda Function Fault) , 失败的 ECS 任务( 任务失败) 或外部工人( 活动失败)

仁爱:全球职能 回返数字 : Array.<HistoryEvent> | undefined - 上次失败的羔羊或活动 事件数组,或为空数组.

获取失败ExecutiveMessage(输入CumulusMessage, 获得ExecutiveHistory Function) QQ Object

获取消息用于发布失败的执行通知 .

尝试获取执行中最后一个失败步骤的输入, 这样我们就可以 更新初始执行中不存在的任何颗粒/ PDR 状态 输入.

回到总体执行投入.

仁爱:全球职能 回返数字 : Object - CumulusMessage 执行步骤信息或执行输入信息

是 FileExtension 马特赫德( granuleFile, 扩展名) QQ boolean

检查文件是否有扩展名

仁爱:全球职能 回返数字 : boolean - 文件是否有扩展名

解析例外( 例外) @% 1 string

确保例外作为对象返回

仁爱:全球职能 回返数字 : string - 字符串例外

关于 Cumulus

Cumulus是美国航天局未来地球科学数据流的以云为基础的数据摄取,存档,分发和管理原型.

Cumulus 文档

捐款

做贡献,请 参见我们的贡献准则。 。 。 .

自动使用 npm run build-docs