Class WebhookActivityTypeProperties
- java.lang.Object
-
- com.azure.resourcemanager.datafactory.fluent.models.WebhookActivityTypeProperties
-
public final class WebhookActivityTypeProperties extends Object
WebHook activity type properties.
-
-
Constructor Summary
Constructors Constructor Description WebhookActivityTypeProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.Object
headers()
Get the headers property: Represents the headers that will be sent to the request.WebhookActivityMethod
method()
Get the method property: Rest API method for target endpoint.Object
reportStatusOnCallBack()
Get the reportStatusOnCallBack property: When set to true, statusCode, output and error in callback request body will be consumed by activity.String
timeout()
Get the timeout property: The timeout within which the webhook should be called back.Object
url()
Get the url property: WebHook activity target endpoint and path.void
validate()
Validates the instance.WebhookActivityTypeProperties
withAuthentication(WebActivityAuthentication authentication)
Set the authentication property: Authentication method used for calling the endpoint.WebhookActivityTypeProperties
withBody(Object body)
Set the body property: Represents the payload that will be sent to the endpoint.WebhookActivityTypeProperties
withHeaders(Object headers)
Set the headers property: Represents the headers that will be sent to the request.WebhookActivityTypeProperties
withMethod(WebhookActivityMethod method)
Set the method property: Rest API method for target endpoint.WebhookActivityTypeProperties
withReportStatusOnCallBack(Object reportStatusOnCallBack)
Set the reportStatusOnCallBack property: When set to true, statusCode, output and error in callback request body will be consumed by activity.WebhookActivityTypeProperties
withTimeout(String timeout)
Set the timeout property: The timeout within which the webhook should be called back.WebhookActivityTypeProperties
withUrl(Object url)
Set the url property: WebHook activity target endpoint and path.
-
-
-
Method Detail
-
method
public WebhookActivityMethod method()
Get the method property: Rest API method for target endpoint.- Returns:
- the method value.
-
withMethod
public WebhookActivityTypeProperties withMethod(WebhookActivityMethod method)
Set the method property: Rest API method for target endpoint.- Parameters:
method
- the method value to set.- Returns:
- the WebhookActivityTypeProperties object itself.
-
url
public Object url()
Get the url property: WebHook activity target endpoint and path. Type: string (or Expression with resultType string).- Returns:
- the url value.
-
withUrl
public WebhookActivityTypeProperties withUrl(Object url)
Set the url property: WebHook activity target endpoint and path. Type: string (or Expression with resultType string).- Parameters:
url
- the url value to set.- Returns:
- the WebhookActivityTypeProperties object itself.
-
timeout
public String timeout()
Get the timeout property: The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).- Returns:
- the timeout value.
-
withTimeout
public WebhookActivityTypeProperties withTimeout(String timeout)
Set the timeout property: The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).- Parameters:
timeout
- the timeout value to set.- Returns:
- the WebhookActivityTypeProperties object itself.
-
headers
public 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.
-
withHeaders
public WebhookActivityTypeProperties withHeaders(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 WebhookActivityTypeProperties object itself.
-
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.
-
withBody
public WebhookActivityTypeProperties 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 WebhookActivityTypeProperties object itself.
-
authentication
public WebActivityAuthentication authentication()
Get the authentication property: Authentication method used for calling the endpoint.- Returns:
- the authentication value.
-
withAuthentication
public WebhookActivityTypeProperties withAuthentication(WebActivityAuthentication authentication)
Set the authentication property: Authentication method used for calling the endpoint.- Parameters:
authentication
- the authentication value to set.- Returns:
- the WebhookActivityTypeProperties object itself.
-
reportStatusOnCallBack
public Object reportStatusOnCallBack()
Get the reportStatusOnCallBack property: When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean).- Returns:
- the reportStatusOnCallBack value.
-
withReportStatusOnCallBack
public WebhookActivityTypeProperties withReportStatusOnCallBack(Object reportStatusOnCallBack)
Set the reportStatusOnCallBack property: When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean).- Parameters:
reportStatusOnCallBack
- the reportStatusOnCallBack value to set.- Returns:
- the WebhookActivityTypeProperties object itself.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-