Class WebhooksClient

java.lang.Object

ink.icoding.github4j.GithubClient

ink.icoding.github4j.client.WebhooksClient

public class WebhooksClient
extends GithubClient

GitHub Webhooks API 客户端。

提供仓库 Webhook 和组织 Webhook 的 CRUD 操作、Ping 测试、投递记录查询和重发等功能。

对应 GitHub REST API 文档: Webhooks

See Also:

• GithubClient

Constructor Summary

Constructors

Constructor	Description
WebhooksClient(GithubClient parent)

Method Summary

Modifier and Type	Method	Description
GithubResponse<Webhook>	createForOrg(String org, CreateWebhookRequest request)	为指定组织创建 Webhook。
GithubResponse<Webhook>	createForRepo(String owner, String repo, CreateWebhookRequest request)	为指定仓库创建 Webhook。
void	deleteForOrg(String org, int hookId)	删除指定组织的 Webhook。
void	deleteForRepo(String owner, String repo, int hookId)	删除指定仓库的 Webhook。
GithubResponse<WebhookDelivery>	getDeliveryForRepo(String owner, String repo, int hookId, long deliveryId)	获取指定仓库 Webhook 的单条投递记录。
GithubResponse<Webhook>	getForOrg(String org, int hookId)	获取指定组织的单个 Webhook。
GithubResponse<Webhook>	getForRepo(String owner, String repo, int hookId)	获取指定仓库的单个 Webhook。
Page<WebhookDelivery>	listDeliveriesForRepo(String owner, String repo, int hookId, PageOptions options)	列出指定仓库 Webhook 的投递记录。
Page<Webhook>	listForOrg(String org, PageOptions options)	列出指定组织的 Webhook。
Page<Webhook>	listForRepo(String owner, String repo, PageOptions options)	列出指定仓库的 Webhook。
void	pingForOrg(String org, int hookId)	向指定组织的 Webhook 发送 Ping 请求。
void	pingForRepo(String owner, String repo, int hookId)	向指定仓库的 Webhook 发送 Ping 请求。
void	redeliverForRepo(String owner, String repo, int hookId, long deliveryId)	重新投递指定仓库 Webhook 的某条投递记录。
GithubResponse<Webhook>	updateForOrg(String org, int hookId, UpdateWebhookRequest request)	更新指定组织的 Webhook。
GithubResponse<Webhook>	updateForRepo(String owner, String repo, int hookId, UpdateWebhookRequest request)	更新指定仓库的 Webhook。

Methods inherited from class GithubClient

actions, builder, configureObjectMapper, delete, get, get, getPaged, getRaw, gists, git, issues, meta, notifications, orgs, patch, post, projects, pulls, put, putNoBody, releases, repos, search, teams, users, webhooks

Modifier and Type	Method	Description
ActionsClient	actions()
static GithubClientBuilder	builder()
protected com.fasterxml.jackson.databind.ObjectMapper	configureObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)
protected GithubResponse<Void>	delete(String path)
protected <T> GithubResponse<T>	get(String path, com.fasterxml.jackson.core.type.TypeReference<T> typeRef, Map<String,String> queryParams)
protected <T> GithubResponse<T>	get(String path, Class<T> responseType, Map<String,String> queryParams)
protected <T> Page<T>	getPaged(String path, Class<T> itemType, Map<String,String> queryParams)
protected GithubResponse<byte[]>	getRaw(String path, Map<String,String> queryParams)
GistsClient	gists()
GitClient	git()
IssuesClient	issues()
MetaClient	meta()
NotificationsClient	notifications()
OrgsClient	orgs()
protected <T> GithubResponse<T>	patch(String path, Object body, Class<T> responseType)
protected <T> GithubResponse<T>	post(String path, Object body, Class<T> responseType)
ProjectsClient	projects()
PullRequestsClient	pulls()
protected <T> GithubResponse<T>	put(String path, Object body, Class<T> responseType)
protected GithubResponse<Void>	putNoBody(String path)
ReleasesClient	releases()
ReposClient	repos()
SearchClient	search()
TeamsClient	teams()
UsersClient	users()
WebhooksClient	webhooks()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebhooksClient

public WebhooksClient(GithubClient parent)

Method Details

listForRepo

public Page<Webhook> listForRepo(String owner,
 String repo,
 PageOptions options)

列出指定仓库的 Webhook。

API 端点: GET /repos/{owner}/{repo}/hooks

Parameters:

owner - 仓库所有者

repo - 仓库名称

options - 分页选项，可为 null

Returns:

分页的 Webhook 列表

getForRepo

public GithubResponse<Webhook> getForRepo(String owner,
 String repo,
 int hookId)

获取指定仓库的单个 Webhook。

API 端点: GET /repos/{owner}/{repo}/hooks/{hook_id}

Parameters:

owner - 仓库所有者

repo - 仓库名称

hookId - Webhook 的 ID

Returns:

Webhook 详细信息

createForRepo

public GithubResponse<Webhook> createForRepo(String owner,
 String repo,
 CreateWebhookRequest request)

为指定仓库创建 Webhook。

API 端点: POST /repos/{owner}/{repo}/hooks

Parameters:

owner - 仓库所有者

repo - 仓库名称

request - 创建 Webhook 的请求参数

Returns:

创建成功后的 Webhook 信息

updateForRepo

public GithubResponse<Webhook> updateForRepo(String owner,
 String repo,
 int hookId,
 UpdateWebhookRequest request)

更新指定仓库的 Webhook。

API 端点: PATCH /repos/{owner}/{repo}/hooks/{hook_id}

Parameters:

owner - 仓库所有者

repo - 仓库名称

hookId - Webhook 的 ID

request - 更新 Webhook 的请求参数

Returns:

更新后的 Webhook 信息

deleteForRepo

public void deleteForRepo(String owner,
 String repo,
 int hookId)

删除指定仓库的 Webhook。

API 端点: DELETE /repos/{owner}/{repo}/hooks/{hook_id}

Parameters:

owner - 仓库所有者

repo - 仓库名称

hookId - Webhook 的 ID

pingForRepo

public void pingForRepo(String owner,
 String repo,
 int hookId)

向指定仓库的 Webhook 发送 Ping 请求。

API 端点: POST /repos/{owner}/{repo}/hooks/{hook_id}/pings

Parameters:

owner - 仓库所有者

repo - 仓库名称

hookId - Webhook 的 ID

listDeliveriesForRepo

public Page<WebhookDelivery> listDeliveriesForRepo(String owner,
 String repo,
 int hookId,
 PageOptions options)

列出指定仓库 Webhook 的投递记录。

API 端点: GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries

Parameters:

owner - 仓库所有者

repo - 仓库名称

hookId - Webhook 的 ID

options - 分页选项，可为 null

Returns:

分页的 Webhook 投递记录列表

getDeliveryForRepo

public GithubResponse<WebhookDelivery> getDeliveryForRepo(String owner,
 String repo,
 int hookId,
 long deliveryId)

获取指定仓库 Webhook 的单条投递记录。

API 端点: GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}

Parameters:

owner - 仓库所有者

repo - 仓库名称

hookId - Webhook 的 ID

deliveryId - 投递记录的 ID

Returns:

Webhook 投递记录详情

redeliverForRepo

public void redeliverForRepo(String owner,
 String repo,
 int hookId,
 long deliveryId)

重新投递指定仓库 Webhook 的某条投递记录。

API 端点: POST /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts

Parameters:

owner - 仓库所有者

repo - 仓库名称

hookId - Webhook 的 ID

deliveryId - 投递记录的 ID

listForOrg

public Page<Webhook> listForOrg(String org,
 PageOptions options)

列出指定组织的 Webhook。

API 端点: GET /orgs/{org}/hooks

Parameters:

org - 组织名称

options - 分页选项，可为 null

Returns:

分页的 Webhook 列表

getForOrg

public GithubResponse<Webhook> getForOrg(String org,
 int hookId)

获取指定组织的单个 Webhook。

API 端点: GET /orgs/{org}/hooks/{hook_id}

Parameters:

org - 组织名称

hookId - Webhook 的 ID

Returns:

Webhook 详细信息

createForOrg

public GithubResponse<Webhook> createForOrg(String org,
 CreateWebhookRequest request)

为指定组织创建 Webhook。

API 端点: POST /orgs/{org}/hooks

Parameters:

org - 组织名称

request - 创建 Webhook 的请求参数

Returns:

创建成功后的 Webhook 信息

updateForOrg

public GithubResponse<Webhook> updateForOrg(String org,
 int hookId,
 UpdateWebhookRequest request)

更新指定组织的 Webhook。

API 端点: PATCH /orgs/{org}/hooks/{hook_id}

Parameters:

org - 组织名称

hookId - Webhook 的 ID

request - 更新 Webhook 的请求参数

Returns:

更新后的 Webhook 信息

deleteForOrg

public void deleteForOrg(String org,
 int hookId)

删除指定组织的 Webhook。

API 端点: DELETE /orgs/{org}/hooks/{hook_id}

Parameters:

org - 组织名称

hookId - Webhook 的 ID

pingForOrg

public void pingForOrg(String org,
 int hookId)

向指定组织的 Webhook 发送 Ping 请求。

API 端点: POST /orgs/{org}/hooks/{hook_id}/pings

Parameters:

org - 组织名称

hookId - Webhook 的 ID