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

Class AzureFunctionActivity

java.lang.Object
com.azure.analytics.synapse.artifacts.models.Activity
com.azure.analytics.synapse.artifacts.models.ExecutionActivity
com.azure.analytics.synapse.artifacts.models.AzureFunctionActivity
public class AzureFunctionActivity extends ExecutionActivity
Azure Function activity.

  • Constructor Details

    • AzureFunctionActivity

      public AzureFunctionActivity()

  • Method Details

    • getMethod

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

    • setMethod

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

    • getFunctionName

      public Object getFunctionName()
      Get the functionName property: Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string).
      Returns:
      the functionName value.

    • setFunctionName

      public AzureFunctionActivity setFunctionName(Object functionName)
      Set the functionName property: Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string).
      Parameters:
      functionName - the functionName value to set.
      Returns:
      the AzureFunctionActivity 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 AzureFunctionActivity 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 AzureFunctionActivity 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 AzureFunctionActivity 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 AzureFunctionActivity object itself.

    • setLinkedServiceName

      public AzureFunctionActivity setLinkedServiceName(LinkedServiceReference linkedServiceName)
      Set the linkedServiceName property: Linked service reference.
      Overrides:
      setLinkedServiceName in class ExecutionActivity
      Parameters:
      linkedServiceName - the linkedServiceName value to set.
      Returns:
      the ExecutionActivity object itself.

    • setPolicy

      public AzureFunctionActivity setPolicy(ActivityPolicy policy)
      Set the policy property: Activity policy.
      Overrides:
      setPolicy in class ExecutionActivity
      Parameters:
      policy - the policy value to set.
      Returns:
      the ExecutionActivity object itself.

    • setName

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

    • setDescription

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

    • setDependsOn

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

    • setUserProperties

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