AzureFunctionActivity Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

public class AzureFunctionActivity
extends ExecutionActivity

Azure Function activity.

Constructor Summary

Constructor Description
AzureFunctionActivity()

Creates an instance of AzureFunctionActivity class.

Method Summary

Modifier and Type Method and Description
static AzureFunctionActivity fromJson(JsonReader jsonReader)

Reads an instance of AzureFunctionActivity from the JsonReader.
Object getBody()

Get the body property: Represents the payload that will be sent to the endpoint.
Object getFunctionName()

Get the functionName property: Name of the Function that the Azure Function Activity will call.
Object getHeaders()

Get the headers property: Represents the headers that will be sent to the request.
AzureFunctionActivityMethod getMethod()

Get the method property: Rest API method for target endpoint.
String getType()

Get the type property: Type of activity.
AzureFunctionActivity setBody(Object body)

Set the body property: Represents the payload that will be sent to the endpoint.
AzureFunctionActivity setDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.
AzureFunctionActivity setDescription(String description)

Set the description property: Activity description.
AzureFunctionActivity setFunctionName(Object functionName)

Set the functionName property: Name of the Function that the Azure Function Activity will call.
AzureFunctionActivity setHeaders(Object headers)

Set the headers property: Represents the headers that will be sent to the request.
AzureFunctionActivity setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.
AzureFunctionActivity setMethod(AzureFunctionActivityMethod method)

Set the method property: Rest API method for target endpoint.
AzureFunctionActivity setName(String name)

Set the name property: Activity name.
AzureFunctionActivity setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.
AzureFunctionActivity setPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.
AzureFunctionActivity setState(ActivityState state)

Set the state property: Activity state.
AzureFunctionActivity setUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from Activity

getAdditionalProperties getDependsOn getDescription getName getOnInactiveMarkAs getState getUserProperties setAdditionalProperties

Methods inherited from ExecutionActivity

fromJson getLinkedServiceName getPolicy getType setDependsOn setDescription setLinkedServiceName setName setOnInactiveMarkAs setPolicy setState setUserProperties toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureFunctionActivity

public AzureFunctionActivity()

Creates an instance of AzureFunctionActivity class.

Method Details

fromJson

public static AzureFunctionActivity fromJson(JsonReader jsonReader)

Reads an instance of AzureFunctionActivity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureFunctionActivity if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

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.

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.

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.

getMethod

public AzureFunctionActivityMethod getMethod()

Get the method property: Rest API method for target endpoint.

Returns:

the method value.

getType

public String getType()

Get the type property: Type of activity.

Overrides:

AzureFunctionActivity.getType()

Returns:

the type 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.

setDependsOn

public AzureFunctionActivity setDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

AzureFunctionActivity.setDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

setDescription

public AzureFunctionActivity setDescription(String description)

Set the description property: Activity description.

Overrides:

AzureFunctionActivity.setDescription(String description)

Parameters:

description

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.

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.

setLinkedServiceName

public AzureFunctionActivity setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

AzureFunctionActivity.setLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

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.

setName

public AzureFunctionActivity setName(String name)

Set the name property: Activity name.

Overrides:

AzureFunctionActivity.setName(String name)

Parameters:

name

setOnInactiveMarkAs

public AzureFunctionActivity setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

Overrides:

AzureFunctionActivity.setOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

setPolicy

public AzureFunctionActivity setPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Overrides:

AzureFunctionActivity.setPolicy(ActivityPolicy policy)

Parameters:

policy

setState

public AzureFunctionActivity setState(ActivityState state)

Set the state property: Activity state. This is an optional property and if not provided, the state will be Active by default.

Overrides:

AzureFunctionActivity.setState(ActivityState state)

Parameters:

state

setUserProperties

public AzureFunctionActivity setUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

AzureFunctionActivity.setUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AzureFunctionActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to