Package com.azure.resourcemanager.datafactory.models

Class WebhookActivity

java.lang.Object
com.azure.resourcemanager.datafactory.models.Activity
com.azure.resourcemanager.datafactory.models.ControlActivity
com.azure.resourcemanager.datafactory.models.WebhookActivity
public final class WebhookActivity extends ControlActivity
WebHook activity.

  • Constructor Details

    • WebhookActivity

      public WebhookActivity()
      Creates an instance of WebhookActivity class.

  • Method Details

    • withName

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

    • withDescription

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

    • withDependsOn

      public WebhookActivity withDependsOn(List<ActivityDependency> dependsOn)
      Set the dependsOn property: Activity depends on condition.
      Overrides:
      withDependsOn in class ControlActivity
      Parameters:
      dependsOn - the dependsOn value to set.
      Returns:
      the Activity object itself.

    • withUserProperties

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

    • method

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

    • withMethod

      public WebhookActivity withMethod(WebhookActivityMethod method)
      Set the method property: Rest API method for target endpoint.
      Parameters:
      method - the method value to set.
      Returns:
      the WebhookActivity object itself.

    • url

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

    • withUrl

      public WebhookActivity withUrl(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.

    • timeout

      public String timeout()
      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.

    • withTimeout

      public WebhookActivity withTimeout(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.

    • headers

      public Object headers()
      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.

    • withHeaders

      public WebhookActivity withHeaders(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.

    • body

      public Object body()
      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.

    • withBody

      public WebhookActivity withBody(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.

    • authentication

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

    • withAuthentication

      public WebhookActivity withAuthentication(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.

    • reportStatusOnCallBack

      public Object reportStatusOnCallBack()
      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.

    • withReportStatusOnCallBack

      public WebhookActivity withReportStatusOnCallBack(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.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ControlActivity
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.