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()
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()
abstract PagedIterable<WebhookEventInfo> listEvents()
abstract PagedFlux<WebhookEventInfo> listEventsAsync()
abstract String parentId()
abstract String ping()
abstract Mono<String> pingAsync()
abstract ProvisioningState provisioningState()
abstract String scope()
abstract String serviceUri()
abstract Collection<WebhookAction> triggers()

Method Details

customHeaders

public abstract Map customHeaders()

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()

Returns:

the status of the webhook

listEvents

public abstract PagedIterable listEvents()

Returns:

the list of event info object

listEventsAsync

public abstract PagedFlux listEventsAsync()

Returns:

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

parentId

public abstract String parentId()

Returns:

the webhook parent ID

ping

public abstract String ping()

Returns:

the id on an event info resource

pingAsync

public abstract Mono pingAsync()

Returns:

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

provisioningState

public abstract ProvisioningState provisioningState()

Returns:

the provisioning state of the webhook

scope

public abstract String scope()

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()

Returns:

the service URI for the webhook to post notifications

triggers

public abstract Collection triggers()

Returns:

the list of actions that trigger the webhook to post notifications

Applies to