Class WebActivity
- java.lang.Object
-
- com.azure.analytics.synapse.artifacts.models.Activity
-
- com.azure.analytics.synapse.artifacts.models.ExecutionActivity
-
- com.azure.analytics.synapse.artifacts.models.WebActivity
-
public class WebActivity extends ExecutionActivity
Web activity.
-
-
Constructor Summary
Constructors Constructor Description WebActivity()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WebActivityAuthentication
getAuthentication()
Get the authentication property: Authentication method used for calling the endpoint.Object
getBody()
Get the body property: Represents the payload that will be sent to the endpoint.IntegrationRuntimeReference
getConnectVia()
Get the connectVia property: The integration runtime reference.List<DatasetReference>
getDatasets()
Get the datasets property: List of datasets passed to web endpoint.Object
getHeaders()
Get the headers property: Represents the headers that will be sent to the request.List<LinkedServiceReference>
getLinkedServices()
Get the linkedServices property: List of linked services passed to web endpoint.WebActivityMethod
getMethod()
Get the method property: Rest API method for target endpoint.Object
getUrl()
Get the url property: Web activity target endpoint and path.WebActivity
setAuthentication(WebActivityAuthentication authentication)
Set the authentication property: Authentication method used for calling the endpoint.WebActivity
setBody(Object body)
Set the body property: Represents the payload that will be sent to the endpoint.WebActivity
setConnectVia(IntegrationRuntimeReference connectVia)
Set the connectVia property: The integration runtime reference.WebActivity
setDatasets(List<DatasetReference> datasets)
Set the datasets property: List of datasets passed to web endpoint.WebActivity
setDependsOn(List<ActivityDependency> dependsOn)
Set the dependsOn property: Activity depends on condition.WebActivity
setDescription(String description)
Set the description property: Activity description.WebActivity
setHeaders(Object headers)
Set the headers property: Represents the headers that will be sent to the request.WebActivity
setLinkedServiceName(LinkedServiceReference linkedServiceName)
Set the linkedServiceName property: Linked service reference.WebActivity
setLinkedServices(List<LinkedServiceReference> linkedServices)
Set the linkedServices property: List of linked services passed to web endpoint.WebActivity
setMethod(WebActivityMethod method)
Set the method property: Rest API method for target endpoint.WebActivity
setName(String name)
Set the name property: Activity name.WebActivity
setPolicy(ActivityPolicy policy)
Set the policy property: Activity policy.WebActivity
setUrl(Object url)
Set the url property: Web activity target endpoint and path.WebActivity
setUserProperties(List<UserProperty> userProperties)
Set the userProperties property: Activity user properties.-
Methods inherited from class com.azure.analytics.synapse.artifacts.models.ExecutionActivity
getLinkedServiceName, getPolicy
-
Methods inherited from class com.azure.analytics.synapse.artifacts.models.Activity
getAdditionalProperties, getDependsOn, getDescription, getName, getUserProperties, setAdditionalProperties
-
-
-
-
Method Detail
-
getMethod
public WebActivityMethod getMethod()
Get the method property: Rest API method for target endpoint.- Returns:
- the method value.
-
setMethod
public WebActivity setMethod(WebActivityMethod method)
Set the method property: Rest API method for target endpoint.- Parameters:
method
- the method value to set.- Returns:
- the WebActivity object itself.
-
getUrl
public Object getUrl()
Get the url property: Web activity target endpoint and path. Type: string (or Expression with resultType string).- Returns:
- the url value.
-
setUrl
public WebActivity setUrl(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.
-
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 WebActivity 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 WebActivity 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 WebActivity 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 WebActivity object itself.
-
getAuthentication
public WebActivityAuthentication getAuthentication()
Get the authentication property: Authentication method used for calling the endpoint.- Returns:
- the authentication value.
-
setAuthentication
public WebActivity setAuthentication(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.
-
getDatasets
public List<DatasetReference> getDatasets()
Get the datasets property: List of datasets passed to web endpoint.- Returns:
- the datasets value.
-
setDatasets
public WebActivity setDatasets(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.
-
getLinkedServices
public List<LinkedServiceReference> getLinkedServices()
Get the linkedServices property: List of linked services passed to web endpoint.- Returns:
- the linkedServices value.
-
setLinkedServices
public WebActivity setLinkedServices(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.
-
getConnectVia
public IntegrationRuntimeReference getConnectVia()
Get the connectVia property: The integration runtime reference.- Returns:
- the connectVia value.
-
setConnectVia
public WebActivity setConnectVia(IntegrationRuntimeReference connectVia)
Set the connectVia property: The integration runtime reference.- Parameters:
connectVia
- the connectVia value to set.- Returns:
- the WebActivity object itself.
-
setLinkedServiceName
public WebActivity setLinkedServiceName(LinkedServiceReference linkedServiceName)
Set the linkedServiceName property: Linked service reference.- Overrides:
setLinkedServiceName
in classExecutionActivity
- Parameters:
linkedServiceName
- the linkedServiceName value to set.- Returns:
- the ExecutionActivity object itself.
-
setPolicy
public WebActivity setPolicy(ActivityPolicy policy)
Set the policy property: Activity policy.- Overrides:
setPolicy
in classExecutionActivity
- Parameters:
policy
- the policy value to set.- Returns:
- the ExecutionActivity object itself.
-
setName
public WebActivity setName(String name)
Set the name property: Activity name.- Overrides:
setName
in classExecutionActivity
- Parameters:
name
- the name value to set.- Returns:
- the Activity object itself.
-
setDescription
public WebActivity setDescription(String description)
Set the description property: Activity description.- Overrides:
setDescription
in classExecutionActivity
- Parameters:
description
- the description value to set.- Returns:
- the Activity object itself.
-
setDependsOn
public WebActivity setDependsOn(List<ActivityDependency> dependsOn)
Set the dependsOn property: Activity depends on condition.- Overrides:
setDependsOn
in classExecutionActivity
- Parameters:
dependsOn
- the dependsOn value to set.- Returns:
- the Activity object itself.
-
setUserProperties
public WebActivity setUserProperties(List<UserProperty> userProperties)
Set the userProperties property: Activity user properties.- Overrides:
setUserProperties
in classExecutionActivity
- Parameters:
userProperties
- the userProperties value to set.- Returns:
- the Activity object itself.
-
-