Interface Webhook

All Superinterfaces:
com.azure.resourcemanager.resources.fluentcore.arm.models.ChildResource<Registry>, com.azure.resourcemanager.resources.fluentcore.arm.models.ExternalChildResource<Webhook,Registry>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasId, com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<WebhookInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasName, com.azure.resourcemanager.resources.fluentcore.arm.models.HasParent<Registry>, com.azure.resourcemanager.resources.fluentcore.model.Indexable, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<Webhook>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource, com.azure.resourcemanager.resources.fluentcore.model.Updatable<Webhook.Update>
public interface Webhook extends com.azure.resourcemanager.resources.fluentcore.arm.models.ExternalChildResource<Webhook,Registry>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource, com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<WebhookInner>, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<Webhook>, com.azure.resourcemanager.resources.fluentcore.model.Updatable<Webhook.Update>
An object that represents a webhook for a container registry.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Webhook.DefinitionStages
    Grouping of webhook definition stages.
    static interface 
    Webhook.Update
    The entirety of a webhook update.
    static interface 
    Webhook.UpdateDefinition<ParentT>
    Grouping of the container registry's webhook update definition.
    static interface 
    Webhook.UpdateDefinitionStages
    Grouping of webhook update definition stages.
    static interface 
    Webhook.UpdateResource<ParentT>
    The entirety of a webhook resource update as part of a container registry update.
    static interface 
    Webhook.UpdateResourceStages
    Grouping of webhook update stages applicable as part of a container registry update.
    static interface 
    Webhook.UpdateStages
    Grouping of webhook update stages.
    static interface 
    Webhook.WebhookDefinition<ParentT>
    Grouping of the container register webhook definitions.

    Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

  • Field Summary

    Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    DUMMY

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    customHeaders()
    Gets the Custom headers that will be added to the webhook notifications.
    void
    disable()
    Changes the status of the webhook to "disabled".
    Mono<Void>
    disableAsync()
    Changes the status of the webhook to "disabled".
    void
    enable()
    Changes the status of the webhook to "enabled".
    Mono<Void>
    enableAsync()
    Changes the status of the webhook to "enabled".
    boolean
    isEnabled()
    Gets the status of the webhook.
    com.azure.core.http.rest.PagedIterable<WebhookEventInfo>
    listEvents()
    Gets the list of event info object.
    com.azure.core.http.rest.PagedFlux<WebhookEventInfo>
    listEventsAsync()
    Gets the list of event info object.
    String
    parentId()
    Gets the webhook parent ID.
    String
    ping()
    Gets the id on an event info resource.
    Mono<String>
    pingAsync()
    Gets the id on an event info resource.
    ProvisioningState
    provisioningState()
    Gets the provisioning state of the webhook.
    String
    scope()
    Gets the scope of repositories where the event can be triggered.
    String
    serviceUri()
    Gets the service URI for the webhook to post notifications.
    Collection<WebhookAction>
    triggers()
    Gets the list of actions that trigger the webhook to post notifications.

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.ExternalChildResource

    id

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

    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.Indexable

    key

    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

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

    update

  • Method Details

    • isEnabled

      boolean isEnabled()
      Gets the status of the webhook.
      Returns:
      the status of the webhook

    • scope

      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

      String serviceUri()
      Gets the service URI for the webhook to post notifications.
      Returns:
      the service URI for the webhook to post notifications

    • customHeaders

      Map<String,String> 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

    • triggers

      Collection<WebhookAction> 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

    • provisioningState

      ProvisioningState provisioningState()
      Gets the provisioning state of the webhook.
      Returns:
      the provisioning state of the webhook

    • parentId

      String parentId()
      Gets the webhook parent ID.
      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()
      Gets the id on an event info resource.
      Returns:
      the id on an event info resource

    • pingAsync

      Mono<String> 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

    • listEvents

      com.azure.core.http.rest.PagedIterable<WebhookEventInfo> listEvents()
      Gets the list of event info object.
      Returns:
      the list of event info object

    • listEventsAsync

      com.azure.core.http.rest.PagedFlux<WebhookEventInfo> 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