airflow.providers.jenkins.operators.jenkins_job_trigger¶
模块内容¶
类¶
触发一个 Jenkins 作业并监控其执行。 |
函数¶
|
从原始请求创建 Jenkins 请求。 |
属性¶
- airflow.providers.jenkins.operators.jenkins_job_trigger.jenkins_request_with_headers(jenkins_server, req)[source]¶
从原始请求创建 Jenkins 请求。
我们需要获取头部信息以及响应体，以便从中获取位置。此函数使用 python-jenkins 中的
jenkins_request，只是更改了返回调用。- 参数
jenkins_server (jenkins.Jenkins) – 要查询的服务器
req (requests.Request) – 要执行的请求
- 返回
包含响应体（键为 body）和随之而来的头部信息（headers）的字典
- 返回类型
JenkinsRequest
- class airflow.providers.jenkins.operators.jenkins_job_trigger.JenkinsJobTriggerOperator(*, jenkins_connection_id, job_name, parameters=None, sleep_time=10, max_try_before_job_appears=10, allowed_jenkins_states=None, **kwargs)[source]¶
基类：
airflow.models.BaseOperator触发一个 Jenkins 作业并监控其执行。
此运算符依赖于 python-jenkins 库版本 >= 0.4.15 与 Jenkins 服务器通信。您还需要在连接屏幕中配置 Jenkins 连接。
- 参数
jenkins_connection_id (str) – 用于此作业的 Jenkins 连接 ID
job_name (str) – 要触发的作业名称
parameters (ParamType) – 触发构建时提供给 Jenkins 以在 API 调用中使用的参数块。（已模板化）
sleep_time (int) – 运算符在每次作业状态请求之间休眠的时间（最小 1，默认 10）
max_try_before_job_appears (int) – 在等待作业出现在 Jenkins 服务器上时，要进行的最大请求次数（默认 10）
allowed_jenkins_states (collections.abc.Iterable[str] | None) – 允许的 Jenkins 状态结果的可迭代对象，默认为
['SUCCESS']
- template_fields: collections.abc.Sequence[str] = ('parameters',)[source]¶
- template_ext: collections.abc.Sequence[str] = ('.json',)[source]¶
- build_job(jenkins_server, params=None)[source]¶
触发构建作业。
这将返回一个带有 2 个键
body和headers的字典。headers还包含一个类字典对象，可以查询以获取队列中的轮询位置。- 参数
jenkins_server (jenkins.Jenkins) – 应触发作业的 Jenkins 服务器
params (ParamType) – 提供给 Jenkins API 调用的参数块。
- 返回
包含响应体（键为 body）和随之而来的头部信息（headers）的字典
- 返回类型
JenkinsRequest