-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
WebActivity.cs
130 lines (122 loc) · 9.26 KB
/
WebActivity.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// <auto-generated/>
#nullable disable
using System;
using System.Collections.Generic;
using Azure.Core.Expressions.DataFactory;
namespace Azure.ResourceManager.DataFactory.Models
{
/// <summary> Web activity. </summary>
public partial class WebActivity : ExecutionActivity
{
/// <summary> Initializes a new instance of <see cref="WebActivity"/>. </summary>
/// <param name="name"> Activity name. </param>
/// <param name="method"> Rest API method for target endpoint. </param>
/// <param name="uri"> Web activity target endpoint and path. Type: string (or Expression with resultType string). </param>
/// <exception cref="ArgumentNullException"> <paramref name="name"/> or <paramref name="uri"/> is null. </exception>
public WebActivity(string name, WebActivityMethod method, DataFactoryElement<string> uri) : base(name)
{
Argument.AssertNotNull(name, nameof(name));
Argument.AssertNotNull(uri, nameof(uri));
Method = method;
Uri = uri;
RequestHeaders = new ChangeTrackingDictionary<string, BinaryData>();
Datasets = new ChangeTrackingList<DatasetReference>();
LinkedServices = new ChangeTrackingList<DataFactoryLinkedServiceReference>();
ActivityType = "WebActivity";
}
/// <summary> Initializes a new instance of <see cref="WebActivity"/>. </summary>
/// <param name="name"> Activity name. </param>
/// <param name="activityType"> Type of activity. </param>
/// <param name="description"> Activity description. </param>
/// <param name="state"> Activity state. This is an optional property and if not provided, the state will be Active by default. </param>
/// <param name="onInactiveMarkAs"> 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. </param>
/// <param name="dependsOn"> Activity depends on condition. </param>
/// <param name="userProperties"> Activity user properties. </param>
/// <param name="additionalProperties"> Additional Properties. </param>
/// <param name="linkedServiceName"> Linked service reference. </param>
/// <param name="policy"> Activity policy. </param>
/// <param name="method"> Rest API method for target endpoint. </param>
/// <param name="uri"> Web activity target endpoint and path. Type: string (or Expression with resultType string). </param>
/// <param name="requestHeaders"> 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). </param>
/// <param name="body"> 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). </param>
/// <param name="authentication"> Authentication method used for calling the endpoint. </param>
/// <param name="disableCertValidation"> When set to true, Certificate validation will be disabled. </param>
/// <param name="httpRequestTimeout"> 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. </param>
/// <param name="turnOffAsync"> 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. </param>
/// <param name="datasets"> List of datasets passed to web endpoint. </param>
/// <param name="linkedServices"> List of linked services passed to web endpoint. </param>
/// <param name="connectVia"> The integration runtime reference. </param>
internal WebActivity(string name, string activityType, string description, PipelineActivityState? state, ActivityOnInactiveMarkAs? onInactiveMarkAs, IList<PipelineActivityDependency> dependsOn, IList<PipelineActivityUserProperty> userProperties, IDictionary<string, BinaryData> additionalProperties, DataFactoryLinkedServiceReference linkedServiceName, PipelineActivityPolicy policy, WebActivityMethod method, DataFactoryElement<string> uri, IDictionary<string, BinaryData> requestHeaders, DataFactoryElement<string> body, WebActivityAuthentication authentication, bool? disableCertValidation, DataFactoryElement<string> httpRequestTimeout, bool? turnOffAsync, IList<DatasetReference> datasets, IList<DataFactoryLinkedServiceReference> linkedServices, IntegrationRuntimeReference connectVia) : base(name, activityType, description, state, onInactiveMarkAs, dependsOn, userProperties, additionalProperties, linkedServiceName, policy)
{
Method = method;
Uri = uri;
RequestHeaders = requestHeaders;
Body = body;
Authentication = authentication;
DisableCertValidation = disableCertValidation;
HttpRequestTimeout = httpRequestTimeout;
TurnOffAsync = turnOffAsync;
Datasets = datasets;
LinkedServices = linkedServices;
ConnectVia = connectVia;
ActivityType = activityType ?? "WebActivity";
}
/// <summary> Initializes a new instance of <see cref="WebActivity"/> for deserialization. </summary>
internal WebActivity()
{
}
/// <summary> Rest API method for target endpoint. </summary>
public WebActivityMethod Method { get; set; }
/// <summary> Web activity target endpoint and path. Type: string (or Expression with resultType string). </summary>
public DataFactoryElement<string> Uri { get; set; }
/// <summary>
/// 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).
/// <para>
/// To assign an object to the value of this property use <see cref="BinaryData.FromObjectAsJson{T}(T, System.Text.Json.JsonSerializerOptions?)"/>.
/// </para>
/// <para>
/// To assign an already formatted json string to this property use <see cref="BinaryData.FromString(string)"/>.
/// </para>
/// <para>
/// Examples:
/// <list type="bullet">
/// <item>
/// <term>BinaryData.FromObjectAsJson("foo")</term>
/// <description>Creates a payload of "foo".</description>
/// </item>
/// <item>
/// <term>BinaryData.FromString("\"foo\"")</term>
/// <description>Creates a payload of "foo".</description>
/// </item>
/// <item>
/// <term>BinaryData.FromObjectAsJson(new { key = "value" })</term>
/// <description>Creates a payload of { "key": "value" }.</description>
/// </item>
/// <item>
/// <term>BinaryData.FromString("{\"key\": \"value\"}")</term>
/// <description>Creates a payload of { "key": "value" }.</description>
/// </item>
/// </list>
/// </para>
/// </summary>
public IDictionary<string, BinaryData> RequestHeaders { get; }
/// <summary> 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). </summary>
public DataFactoryElement<string> Body { get; set; }
/// <summary> Authentication method used for calling the endpoint. </summary>
public WebActivityAuthentication Authentication { get; set; }
/// <summary> When set to true, Certificate validation will be disabled. </summary>
public bool? DisableCertValidation { get; set; }
/// <summary> 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. </summary>
public DataFactoryElement<string> HttpRequestTimeout { get; set; }
/// <summary> 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. </summary>
public bool? TurnOffAsync { get; set; }
/// <summary> List of datasets passed to web endpoint. </summary>
public IList<DatasetReference> Datasets { get; }
/// <summary> List of linked services passed to web endpoint. </summary>
public IList<DataFactoryLinkedServiceReference> LinkedServices { get; }
/// <summary> The integration runtime reference. </summary>
public IntegrationRuntimeReference ConnectVia { get; set; }
}
}