Package com.azure.analytics.synapse.artifacts.models

Class WebHookActivity

    • Constructor Detail

      • WebHookActivity

        public WebHookActivity()

    • Method Detail

      • getMethod

        public WebHookActivityMethod getMethod()
        Get the method property: Rest API method for target endpoint.
        Returns:
        the method value.

      • setMethod

        public WebHookActivity setMethod​(WebHookActivityMethod method)
        Set the method property: Rest API method for target endpoint.
        Parameters:
        method - the method value to set.
        Returns:
        the WebHookActivity object itself.

      • getUrl

        public Object getUrl()
        Get the url property: WebHook activity target endpoint and path. Type: string (or Expression with resultType string).
        Returns:
        the url value.

      • setUrl

        public WebHookActivity setUrl​(Object url)
        Set the url property: WebHook activity target endpoint and path. Type: string (or Expression with resultType string).
        Parameters:
        url - the url value to set.
        Returns:
        the WebHookActivity object itself.

      • getTimeout

        public String getTimeout()
        Get the timeout property: The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
        Returns:
        the timeout value.

      • setTimeout

        public WebHookActivity setTimeout​(String timeout)
        Set the timeout property: The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
        Parameters:
        timeout - the timeout value to set.
        Returns:
        the WebHookActivity object itself.

      • getHeaders

        public Object getHeaders()
        Get the headers property: Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).
        Returns:
        the headers value.

      • setHeaders

        public WebHookActivity setHeaders​(Object headers)
        Set the headers property: Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).
        Parameters:
        headers - the headers value to set.
        Returns:
        the WebHookActivity object itself.

      • getBody

        public Object getBody()
        Get the body property: Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).
        Returns:
        the body value.

      • setBody

        public WebHookActivity setBody​(Object body)
        Set the body property: Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).
        Parameters:
        body - the body value to set.
        Returns:
        the WebHookActivity object itself.

      • getAuthentication

        public WebActivityAuthentication getAuthentication()
        Get the authentication property: Authentication method used for calling the endpoint.
        Returns:
        the authentication value.

      • setAuthentication

        public WebHookActivity setAuthentication​(WebActivityAuthentication authentication)
        Set the authentication property: Authentication method used for calling the endpoint.
        Parameters:
        authentication - the authentication value to set.
        Returns:
        the WebHookActivity object itself.

      • getReportStatusOnCallBack

        public Object getReportStatusOnCallBack()
        Get the reportStatusOnCallBack property: When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean).
        Returns:
        the reportStatusOnCallBack value.

      • setReportStatusOnCallBack

        public WebHookActivity setReportStatusOnCallBack​(Object reportStatusOnCallBack)
        Set the reportStatusOnCallBack property: When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean).
        Parameters:
        reportStatusOnCallBack - the reportStatusOnCallBack value to set.
        Returns:
        the WebHookActivity object itself.

      • setName

        public WebHookActivity setName​(String name)
        Set the name property: Activity name.
        Overrides:
        setName in class ControlActivity
        Parameters:
        name - the name value to set.
        Returns:
        the Activity object itself.

      • setDescription

        public WebHookActivity setDescription​(String description)
        Set the description property: Activity description.
        Overrides:
        setDescription in class ControlActivity
        Parameters:
        description - the description value to set.
        Returns:
        the Activity object itself.

      • setUserProperties

        public WebHookActivity setUserProperties​(List<UserProperty> userProperties)
        Set the userProperties property: Activity user properties.
        Overrides:
        setUserProperties in class ControlActivity
        Parameters:
        userProperties - the userProperties value to set.
        Returns:
        the Activity object itself.