Interface Webhook
-
- All Superinterfaces:
ChildResource<Registry>,ExternalChildResource<Webhook,Registry>,HasId,HasInnerModel<WebhookInner>,HasName,HasParent<Registry>,Indexable,Refreshable<Webhook>,Resource,Updatable<Webhook.Update>
public interface Webhook extends ExternalChildResource<Webhook,Registry>, Resource, HasInnerModel<WebhookInner>, Refreshable<Webhook>, Updatable<Webhook.Update>
An object that represents a webhook for a container registry.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceWebhook.DefinitionStagesGrouping of webhook definition stages.static interfaceWebhook.UpdateThe entirety of a webhook update.static interfaceWebhook.UpdateDefinition<ParentT>Grouping of the container registry's webhook update definition.static interfaceWebhook.UpdateDefinitionStagesGrouping of webhook update definition stages.static interfaceWebhook.UpdateResource<ParentT>The entirety of a webhook resource update as part of a container registry update.static interfaceWebhook.UpdateResourceStagesGrouping of webhook update stages applicable as part of a container registry update.static interfaceWebhook.UpdateStagesGrouping of webhook update stages.static interfaceWebhook.WebhookDefinition<ParentT>Grouping of the container register webhook definitions.-
Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
Resource.DefinitionWithRegion<T extends Object>, Resource.DefinitionWithTags<T extends Object>, Resource.UpdateWithTags<T extends Object>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Map<String,String>customHeaders()voiddisable()Changes the status of the webhook to "disabled".Mono<Void>disableAsync()Changes the status of the webhook to "disabled".voidenable()Changes the status of the webhook to "enabled".Mono<Void>enableAsync()Changes the status of the webhook to "enabled".booleanisEnabled()com.azure.core.http.rest.PagedIterable<WebhookEventInfo>listEvents()com.azure.core.http.rest.PagedFlux<WebhookEventInfo>listEventsAsync()StringparentId()Stringping()Mono<String>pingAsync()ProvisioningStateprovisioningState()Stringscope()StringserviceUri()Collection<WebhookAction>triggers()-
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.ExternalChildResource
id
-
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel
innerModel
-
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName
name
-
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasParent
parent
-
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable
refresh, refreshAsync
-
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
region, regionName, tags, type
-
-
-
-
Method Detail
-
isEnabled
boolean isEnabled()
- Returns:
- the status of the webhook
-
scope
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
String serviceUri()
- Returns:
- the service URI for the webhook to post notifications
-
customHeaders
Map<String,String> customHeaders()
- Returns:
- the Custom headers that will be added to the webhook notifications
-
triggers
Collection<WebhookAction> triggers()
- Returns:
- the list of actions that trigger the webhook to post notifications
-
provisioningState
ProvisioningState provisioningState()
- Returns:
- the provisioning state of the webhook
-
parentId
String parentId()
- Returns:
- the webhook parent ID
-
enable
void enable()
Changes the status of the webhook to "enabled".
-
enableAsync
Mono<Void> enableAsync()
Changes the status of the webhook to "enabled".- Returns:
- a representation of the future computation of this call
-
disable
void disable()
Changes the status of the webhook to "disabled".
-
disableAsync
Mono<Void> disableAsync()
Changes the status of the webhook to "disabled".- Returns:
- a representation of the future computation of this call
-
ping
String ping()
- Returns:
- the id on an event info resource
-
pingAsync
Mono<String> pingAsync()
- Returns:
- a representation of the future computation of this call, returning the id on an event info resource
-
listEvents
com.azure.core.http.rest.PagedIterable<WebhookEventInfo> listEvents()
- Returns:
- the list of event info object
-
listEventsAsync
com.azure.core.http.rest.PagedFlux<WebhookEventInfo> listEventsAsync()
- Returns:
- a representation of the future computation of this call, returning the list of event info object
-
-