AzureFunctionActivity Class

Package:
com.azure.resourcemanager.datafactory.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-datafactory:1.2.0

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

Get the body property: Represents the payload that will be sent to the endpoint.
static AzureFunctionActivity fromJson(JsonReader jsonReader)

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

Get the functionName property: Name of the Function that the Azure Function Activity will call.
Map<String,Object> headers()

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

Get the method property: Rest API method for target endpoint.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Type of activity.
void validate()

Validates the instance.
AzureFunctionActivity withBody(Object body)

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

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

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

Set the functionName property: Name of the Function that the Azure Function Activity will call.
AzureFunctionActivity withHeaders(Map<String,Object> headers)

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

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

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

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

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

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

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

Set the userProperties property: Activity user properties.

Methods inherited from Activity

additionalProperties dependsOn description name onInactiveMarkAs state userProperties withAdditionalProperties

Methods inherited from ExecutionActivity

fromJson linkedServiceName policy toJson type validate withDependsOn withDescription withLinkedServiceName withName withOnInactiveMarkAs withPolicy withState withUserProperties

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

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.

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.

functionName

public Object functionName()

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.

headers

public Map<String,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.

method

public AzureFunctionActivityMethod method()

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

Returns:

the method value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AzureFunctionActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Type of activity.

Overrides:

AzureFunctionActivity.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

AzureFunctionActivity.validate()

withBody

public AzureFunctionActivity 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 AzureFunctionActivity object itself.

withDependsOn

public AzureFunctionActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

AzureFunctionActivity.withDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

withDescription

public AzureFunctionActivity withDescription(String description)

Set the description property: Activity description.

Overrides:

AzureFunctionActivity.withDescription(String description)

Parameters:

description

withFunctionName

public AzureFunctionActivity withFunctionName(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.

withHeaders

public AzureFunctionActivity withHeaders(Map<String,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.

withLinkedServiceName

public AzureFunctionActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

AzureFunctionActivity.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withMethod

public AzureFunctionActivity withMethod(AzureFunctionActivityMethod method)

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

Parameters:

method - the method value to set.

Returns:

the AzureFunctionActivity object itself.

withName

public AzureFunctionActivity withName(String name)

Set the name property: Activity name.

Overrides:

AzureFunctionActivity.withName(String name)

Parameters:

name

withOnInactiveMarkAs

public AzureFunctionActivity withOnInactiveMarkAs(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.withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

withPolicy

public AzureFunctionActivity withPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Overrides:

AzureFunctionActivity.withPolicy(ActivityPolicy policy)

Parameters:

policy

withState

public AzureFunctionActivity withState(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.withState(ActivityState state)

Parameters:

state

withUserProperties

public AzureFunctionActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

AzureFunctionActivity.withUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

Applies to