Package de.hybris.platform.webhookservices.model

Class WebhookConfigurationModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class WebhookConfigurationModel
extends ItemModel
    Generated model class for type WebhookConfiguration first defined at extension webhookservices.

    Configures how a webhook reacts to an event by specifying an event, an Integration Object to transform the event to, and the destination to send the payload.

    See Also:
    Serialized Form

    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values

      • EVENTTYPE

        public static final java.lang.String EVENTTYPE
        Generated constant - Attribute key of WebhookConfiguration.eventType attribute defined at extension webhookservices.
        See Also:
        Constant Field Values

      • INTEGRATIONOBJECT

        public static final java.lang.String INTEGRATIONOBJECT
        Generated constant - Attribute key of WebhookConfiguration.integrationObject attribute defined at extension webhookservices.
        See Also:
        Constant Field Values

      • DESTINATION

        public static final java.lang.String DESTINATION
        Generated constant - Attribute key of WebhookConfiguration.destination attribute defined at extension webhookservices.
        See Also:
        Constant Field Values

      • FILTERLOCATION

        public static final java.lang.String FILTERLOCATION
        Generated constant - Attribute key of WebhookConfiguration.filterLocation attribute defined at extension webhookservices.
        See Also:
        Constant Field Values

    • Constructor Detail

      • WebhookConfigurationModel

        public WebhookConfigurationModel()
        Generated constructor - Default constructor for generic creation.

      • WebhookConfigurationModel

        public WebhookConfigurationModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null

      • WebhookConfigurationModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public WebhookConfigurationModel​(ConsumedDestinationModel _destination,
                                 IntegrationObjectModel _integrationObject)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _destination - initial attribute declared by type WebhookConfiguration at extension webhookservices
        _integrationObject - initial attribute declared by type WebhookConfiguration at extension webhookservices

      • WebhookConfigurationModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public WebhookConfigurationModel​(ConsumedDestinationModel _destination,
                                 IntegrationObjectModel _integrationObject,
                                 ItemModel _owner)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _destination - initial attribute declared by type WebhookConfiguration at extension webhookservices
        _integrationObject - initial attribute declared by type WebhookConfiguration at extension webhookservices
        _owner - initial attribute declared by type Item at extension core

    • Method Detail

      • getDestination

        @Accessor(qualifier="destination",
          type=GETTER)
public ConsumedDestinationModel getDestination()
        Generated method - Getter of the WebhookConfiguration.destination attribute defined at extension webhookservices.
        Returns:
        the destination - The destination this WebhookConfiguration is to send the payload

      • getEventType

        @Accessor(qualifier="eventType",
          type=GETTER)
public java.lang.String getEventType()
        Generated method - Getter of the WebhookConfiguration.eventType attribute defined at extension webhookservices.
        Returns:
        the eventType - The event this WebhookConfiguration responds to

      • getFilterLocation

        @Accessor(qualifier="filterLocation",
          type=GETTER)
public java.lang.String getFilterLocation()
        Generated method - Getter of the WebhookConfiguration.filterLocation attribute defined at extension webhookservices.
        Returns:
        the filterLocation - Specifies the URI of the filter logic. For example, script://orderFilter.

      • getIntegrationObject

        @Accessor(qualifier="integrationObject",
          type=GETTER)
public IntegrationObjectModel getIntegrationObject()
        Generated method - Getter of the WebhookConfiguration.integrationObject attribute defined at extension webhookservices.
        Returns:
        the integrationObject - The IntegrationObject this WebhookConfiguration is to use when sending the payload

      • setDestination

        @Accessor(qualifier="destination",
          type=SETTER)
public void setDestination​(ConsumedDestinationModel value)
        Generated method - Setter of WebhookConfiguration.destination attribute defined at extension webhookservices.
        Parameters:
        value - the destination - The destination this WebhookConfiguration is to send the payload

      • setEventType

        @Accessor(qualifier="eventType",
          type=SETTER)
public void setEventType​(java.lang.String value)
        Generated method - Setter of WebhookConfiguration.eventType attribute defined at extension webhookservices.
        Parameters:
        value - the eventType - The event this WebhookConfiguration responds to

      • setFilterLocation

        @Accessor(qualifier="filterLocation",
          type=SETTER)
public void setFilterLocation​(java.lang.String value)
        Generated method - Setter of WebhookConfiguration.filterLocation attribute defined at extension webhookservices.
        Parameters:
        value - the filterLocation - Specifies the URI of the filter logic. For example, script://orderFilter.

      • setIntegrationObject

        @Accessor(qualifier="integrationObject",
          type=SETTER)
public void setIntegrationObject​(IntegrationObjectModel value)
        Generated method - Setter of WebhookConfiguration.integrationObject attribute defined at extension webhookservices.
        Parameters:
        value - the integrationObject - The IntegrationObject this WebhookConfiguration is to use when sending the payload