WebActivity Class

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

public final class WebActivity
extends ExecutionActivity

Web activity.

Constructor Summary

Constructor Description
WebActivity()

Creates an instance of WebActivity class.

Method Summary

Modifier and Type Method and Description
WebActivityAuthentication authentication()

Get the authentication property: Authentication method used for calling the endpoint.
Object body()

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

Get the connectVia property: The integration runtime reference.
List<DatasetReference> datasets()

Get the datasets property: List of datasets passed to web endpoint.
Boolean disableCertValidation()

Get the disableCertValidation property: When set to true, Certificate validation will be disabled.
static WebActivity fromJson(JsonReader jsonReader)

Reads an instance of WebActivity from the JsonReader.
Map<String,Object> headers()

Get the headers property: Represents the headers that will be sent to the request.
Object httpRequestTimeout()

Get the httpRequestTimeout property: Timeout for the HTTP request to get a response.
List<LinkedServiceReference> linkedServices()

Get the linkedServices property: List of linked services passed to web endpoint.
WebActivityMethod method()

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

Get the turnOffAsync property: Option to disable invoking HTTP GET on location given in response header of a HTTP 202 Response.
String type()

Get the type property: Type of activity.
Object url()

Get the url property: Web activity target endpoint and path.
void validate()

Validates the instance.
WebActivity withAuthentication(WebActivityAuthentication authentication)

Set the authentication property: Authentication method used for calling the endpoint.
WebActivity withBody(Object body)

Set the body property: Represents the payload that will be sent to the endpoint.
WebActivity withConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.
WebActivity withDatasets(List<DatasetReference> datasets)

Set the datasets property: List of datasets passed to web endpoint.
WebActivity withDependsOn(List<ActivityDependency> dependsOn)

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

Set the description property: Activity description.
WebActivity withDisableCertValidation(Boolean disableCertValidation)

Set the disableCertValidation property: When set to true, Certificate validation will be disabled.
WebActivity withHeaders(Map<String,Object> headers)

Set the headers property: Represents the headers that will be sent to the request.
WebActivity withHttpRequestTimeout(Object httpRequestTimeout)

Set the httpRequestTimeout property: Timeout for the HTTP request to get a response.
WebActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.
WebActivity withLinkedServices(List<LinkedServiceReference> linkedServices)

Set the linkedServices property: List of linked services passed to web endpoint.
WebActivity withMethod(WebActivityMethod method)

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

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

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

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

Set the state property: Activity state.
WebActivity withTurnOffAsync(Boolean turnOffAsync)

Set the turnOffAsync property: Option to disable invoking HTTP GET on location given in response header of a HTTP 202 Response.
WebActivity withUrl(Object url)

Set the url property: Web activity target endpoint and path.
WebActivity 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

WebActivity

public WebActivity()

Creates an instance of WebActivity class.

Method Details

authentication

public WebActivityAuthentication authentication()

Get the authentication property: Authentication method used for calling the endpoint.

Returns:

the authentication value.

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.

connectVia

public IntegrationRuntimeReference connectVia()

Get the connectVia property: The integration runtime reference.

Returns:

the connectVia value.

datasets

public List<DatasetReference> datasets()

Get the datasets property: List of datasets passed to web endpoint.

Returns:

the datasets value.

disableCertValidation

public Boolean disableCertValidation()

Get the disableCertValidation property: When set to true, Certificate validation will be disabled.

Returns:

the disableCertValidation value.

fromJson

public static WebActivity fromJson(JsonReader jsonReader)

Reads an instance of WebActivity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of WebActivity 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.

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.

httpRequestTimeout

public Object httpRequestTimeout()

Get the httpRequestTimeout property: Timeout for the HTTP request to get a response. Format is in TimeSpan (hh:mm:ss). This value is the timeout to get a response, not the activity timeout. The default value is 00:01:00 (1 minute). The range is from 1 to 10 minutes.

Returns:

the httpRequestTimeout value.

linkedServices

public List<LinkedServiceReference> linkedServices()

Get the linkedServices property: List of linked services passed to web endpoint.

Returns:

the linkedServices value.

method

public WebActivityMethod method()

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

Returns:

the method value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

WebActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

turnOffAsync

public Boolean turnOffAsync()

Get the turnOffAsync property: Option to disable invoking HTTP GET on location given in response header of a HTTP 202 Response. If set true, it stops invoking HTTP GET on http location given in response header. If set false then continues to invoke HTTP GET call on location given in http response headers.

Returns:

the turnOffAsync value.

type

public String type()

Get the type property: Type of activity.

Overrides:

WebActivity.type()

Returns:

the type value.

url

public Object url()

Get the url property: Web activity target endpoint and path. Type: string (or Expression with resultType string).

Returns:

the url value.

validate

public void validate()

Validates the instance.

Overrides:

WebActivity.validate()

withAuthentication

public WebActivity withAuthentication(WebActivityAuthentication authentication)

Set the authentication property: Authentication method used for calling the endpoint.

Parameters:

authentication - the authentication value to set.

Returns:

the WebActivity object itself.

withBody

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

withConnectVia

public WebActivity withConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Parameters:

connectVia - the connectVia value to set.

Returns:

the WebActivity object itself.

withDatasets

public WebActivity withDatasets(List<DatasetReference> datasets)

Set the datasets property: List of datasets passed to web endpoint.

Parameters:

datasets - the datasets value to set.

Returns:

the WebActivity object itself.

withDependsOn

public WebActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

WebActivity.withDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

withDescription

public WebActivity withDescription(String description)

Set the description property: Activity description.

Overrides:

WebActivity.withDescription(String description)

Parameters:

description

withDisableCertValidation

public WebActivity withDisableCertValidation(Boolean disableCertValidation)

Set the disableCertValidation property: When set to true, Certificate validation will be disabled.

Parameters:

disableCertValidation - the disableCertValidation value to set.

Returns:

the WebActivity object itself.

withHeaders

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

withHttpRequestTimeout

public WebActivity withHttpRequestTimeout(Object httpRequestTimeout)

Set the httpRequestTimeout property: Timeout for the HTTP request to get a response. Format is in TimeSpan (hh:mm:ss). This value is the timeout to get a response, not the activity timeout. The default value is 00:01:00 (1 minute). The range is from 1 to 10 minutes.

Parameters:

httpRequestTimeout - the httpRequestTimeout value to set.

Returns:

the WebActivity object itself.

withLinkedServiceName

public WebActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

WebActivity.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withLinkedServices

public WebActivity withLinkedServices(List<LinkedServiceReference> linkedServices)

Set the linkedServices property: List of linked services passed to web endpoint.

Parameters:

linkedServices - the linkedServices value to set.

Returns:

the WebActivity object itself.

withMethod

public WebActivity withMethod(WebActivityMethod method)

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

Parameters:

method - the method value to set.

Returns:

the WebActivity object itself.

withName

public WebActivity withName(String name)

Set the name property: Activity name.

Overrides:

WebActivity.withName(String name)

Parameters:

name

withOnInactiveMarkAs

public WebActivity 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:

WebActivity.withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

withPolicy

public WebActivity withPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Overrides:

WebActivity.withPolicy(ActivityPolicy policy)

Parameters:

policy

withState

public WebActivity 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:

WebActivity.withState(ActivityState state)

Parameters:

state

withTurnOffAsync

public WebActivity withTurnOffAsync(Boolean turnOffAsync)

Set the turnOffAsync property: Option to disable invoking HTTP GET on location given in response header of a HTTP 202 Response. If set true, it stops invoking HTTP GET on http location given in response header. If set false then continues to invoke HTTP GET call on location given in http response headers.

Parameters:

turnOffAsync - the turnOffAsync value to set.

Returns:

the WebActivity object itself.

withUrl

public WebActivity withUrl(Object url)

Set the url property: Web activity target endpoint and path. Type: string (or Expression with resultType string).

Parameters:

url - the url value to set.

Returns:

the WebActivity object itself.

withUserProperties

public WebActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

WebActivity.withUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

Applies to