Partager via


Webhook Interface

Implements

public interface Webhook
extends ExternalChildResource<Webhook,Registry>, Resource, HasInnerModel<WebhookInner>, Refreshable<Webhook>, Updatable<Update>

An object that represents a webhook for a container registry.

Method Summary

Modifier and Type Method and Description
abstract Map<String,String> customHeaders()

Gets the Custom headers that will be added to the webhook notifications.

abstract void disable()

Changes the status of the webhook to "disabled".

abstract Mono<Void> disableAsync()

Changes the status of the webhook to "disabled".

abstract void enable()

Changes the status of the webhook to "enabled".

abstract Mono<Void> enableAsync()

Changes the status of the webhook to "enabled".

abstract boolean isEnabled()

Gets the status of the webhook.

abstract PagedIterable<WebhookEventInfo> listEvents()

Gets the list of event info object.

abstract PagedFlux<WebhookEventInfo> listEventsAsync()

Gets the list of event info object.

abstract String parentId()

Gets the webhook parent ID.

abstract String ping()

Gets the id on an event info resource.

abstract Mono<String> pingAsync()

Gets the id on an event info resource.

abstract ProvisioningState provisioningState()

Gets the provisioning state of the webhook.

abstract String scope()

Gets the scope of repositories where the event can be triggered.

abstract String serviceUri()

Gets the service URI for the webhook to post notifications.

abstract Collection<WebhookAction> triggers()

Gets the list of actions that trigger the webhook to post notifications.

Method Details

customHeaders

public abstract Map customHeaders()

Gets the Custom headers that will be added to the webhook notifications.

Returns:

the Custom headers that will be added to the webhook notifications

disable

public abstract void disable()

Changes the status of the webhook to "disabled".

disableAsync

public abstract Mono disableAsync()

Changes the status of the webhook to "disabled".

Returns:

a representation of the future computation of this call

enable

public abstract void enable()

Changes the status of the webhook to "enabled".

enableAsync

public abstract Mono enableAsync()

Changes the status of the webhook to "enabled".

Returns:

a representation of the future computation of this call

isEnabled

public abstract boolean isEnabled()

Gets the status of the webhook.

Returns:

the status of the webhook

listEvents

public abstract PagedIterable listEvents()

Gets the list of event info object.

Returns:

the list of event info object

listEventsAsync

public abstract PagedFlux listEventsAsync()

Gets the list of event info object.

Returns:

a representation of the future computation of this call, returning the list of event info object

parentId

public abstract String parentId()

Gets the webhook parent ID.

Returns:

the webhook parent ID

ping

public abstract String ping()

Gets the id on an event info resource.

Returns:

the id on an event info resource

pingAsync

public abstract Mono pingAsync()

Gets the id on an event info resource.

Returns:

a representation of the future computation of this call, returning the id on an event info resource

provisioningState

public abstract ProvisioningState provisioningState()

Gets the provisioning state of the webhook.

Returns:

the provisioning state of the webhook

scope

public abstract String scope()

Gets the scope of repositories where the event can be triggered.

Returns:

the scope of repositories where the event can be triggered

For example: - 'foo:*' means events for all tags under repository 'foo' - 'foo:bar' means events for 'foo:bar' only - 'foo' is equivalent to 'foo:latest' - empty means all events

serviceUri

public abstract String serviceUri()

Gets the service URI for the webhook to post notifications.

Returns:

the service URI for the webhook to post notifications

triggers

public abstract Collection triggers()

Gets the list of actions that trigger the webhook to post notifications.

Returns:

the list of actions that trigger the webhook to post notifications

Applies to