Webhook operations

MLFlowClient.createwebhook — Function

createwebhook(instance::MLFlow, name::String, url::String;
    events::Array{WebhookEvent}=WebhookEvent[],
    description::Union{String, Missing}=missing,
    status::Union{WebhookStatus.WebhookStatusEnum, Missing}=missing,
    secret::Union{String, Missing}=missing)

Create a new webhook. Returns the created Webhook.

Arguments

instance: MLFlow configuration.
name: Name of the webhook.
url: URL to send webhook events to.
events: Events that trigger the webhook.
description: Description of the webhook.
status: Initial status of the webhook.
secret: Secret for webhook verification.

Returns

An instance of type Webhook.

source

MLFlowClient.getwebhook — Function

getwebhook(instance::MLFlow, webhook_id::String)

Get a webhook by its ID.

Arguments

instance: MLFlow configuration.
webhook_id: Unique identifier for the webhook.

Returns

An instance of type Webhook.

source

MLFlowClient.listwebhooks — Function

listwebhooks(instance::MLFlow; max_results::Int64=100, page_token::String="")

List all webhooks.

Arguments

instance: MLFlow configuration.
max_results: Maximum number of webhooks desired.
page_token: Pagination token from previous request.

Returns

Vector of Webhook that were found.
The next page token if there are more results.

source

MLFlowClient.updatewebhook — Function

updatewebhook(instance::MLFlow, webhook_id::String;
    name::Union{String, Missing}=missing,
    description::Union{String, Missing}=missing,
    url::Union{String, Missing}=missing,
    status::Union{WebhookStatus.WebhookStatusEnum, Missing}=missing,
    secret::Union{String, Missing}=missing)

Update a webhook. Returns the updated Webhook.

Arguments

instance: MLFlow configuration.
webhook_id: Unique identifier for the webhook.
name: Updated name for the webhook.
description: Updated description for the webhook.
url: Updated URL for the webhook.
status: Updated status of the webhook.
secret: Updated secret for the webhook.

Returns

An instance of type Webhook.

source

MLFlowClient.deletewebhook — Function

deletewebhook(instance::MLFlow, webhook_id::String)

Delete a webhook.

Arguments

instance: MLFlow configuration.
webhook_id: Unique identifier for the webhook.

Returns

true if successful. Otherwise, raises exception.

source

MLFlowClient.testwebhook — Function

testwebhook(instance::MLFlow, webhook_id::String;
    event::Union{WebhookEvent, Missing}=missing)

Test a webhook.

Arguments

instance: MLFlow configuration.
webhook_id: Unique identifier for the webhook.
event: Optional event to test with.

Returns

An instance of type WebhookTestResult.

source