-
Notifications
You must be signed in to change notification settings - Fork 260
/
UntilActivity.xml
121 lines (121 loc) · 15.4 KB
/
UntilActivity.xml
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
<Type Name="UntilActivity" FullName="Azure.Analytics.Synapse.Artifacts.Models.UntilActivity">
<TypeSignature Language="C#" Value="public class UntilActivity : Azure.Analytics.Synapse.Artifacts.Models.ControlActivity" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit UntilActivity extends Azure.Analytics.Synapse.Artifacts.Models.ControlActivity" />
<TypeSignature Language="DocId" Value="T:Azure.Analytics.Synapse.Artifacts.Models.UntilActivity" />
<TypeSignature Language="VB.NET" Value="Public Class UntilActivity
Inherits ControlActivity" />
<TypeSignature Language="F#" Value="type UntilActivity = class
 inherit ControlActivity" />
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Analytics.Synapse.Artifacts.Models.ControlActivity</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.UntilActivity+UntilActivityConverter))]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.UntilActivity+UntilActivityConverter))>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary> This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public UntilActivity (string name, Azure.Analytics.Synapse.Artifacts.Models.Expression expression, System.Collections.Generic.IEnumerable<Azure.Analytics.Synapse.Artifacts.Models.Activity> activities);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, class Azure.Analytics.Synapse.Artifacts.Models.Expression expression, class System.Collections.Generic.IEnumerable`1<class Azure.Analytics.Synapse.Artifacts.Models.Activity> activities) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Synapse.Artifacts.Models.UntilActivity.#ctor(System.String,Azure.Analytics.Synapse.Artifacts.Models.Expression,System.Collections.Generic.IEnumerable{Azure.Analytics.Synapse.Artifacts.Models.Activity})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, expression As Expression, activities As IEnumerable(Of Activity))" />
<MemberSignature Language="F#" Value="new Azure.Analytics.Synapse.Artifacts.Models.UntilActivity : string * Azure.Analytics.Synapse.Artifacts.Models.Expression * seq<Azure.Analytics.Synapse.Artifacts.Models.Activity> -> Azure.Analytics.Synapse.Artifacts.Models.UntilActivity" Usage="new Azure.Analytics.Synapse.Artifacts.Models.UntilActivity (name, expression, activities)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="expression" Type="Azure.Analytics.Synapse.Artifacts.Models.Expression" />
<Parameter Name="activities" Type="System.Collections.Generic.IEnumerable<Azure.Analytics.Synapse.Artifacts.Models.Activity>" />
</Parameters>
<Docs>
<param name="name"> Activity name. </param>
<param name="expression"> An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true. </param>
<param name="activities">
List of activities to execute.
Please note <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.Activity" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
The available derived classes include <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AppendVariableActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AzureDataExplorerCommandActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AzureFunctionActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AzureMLBatchExecutionActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AzureMLExecutePipelineActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AzureMLUpdateResourceActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ControlActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.CopyActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.CustomActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.DatabricksNotebookActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.DatabricksSparkJarActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.DatabricksSparkPythonActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.DataLakeAnalyticsUsqlActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.DeleteActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ExecuteDataFlowActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ExecutePipelineActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ExecuteSsisPackageActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ExecutionActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.FailActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.FilterActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ForEachActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.GetMetadataActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.HDInsightHiveActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.HDInsightMapReduceActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.HDInsightPigActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.HDInsightSparkActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.HDInsightStreamingActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.IfConditionActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.LookupActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ScriptActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SetVariableActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SynapseSparkJobDefinitionActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SqlPoolStoredProcedureActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SqlServerStoredProcedureActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SwitchActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SynapseNotebookActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.UntilActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ValidationActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.WaitActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.WebActivity" /> and <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.WebHookActivity" />.
</param>
<summary> Initializes a new instance of <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.UntilActivity" />. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" />, <paramref name="expression" /> or <paramref name="activities" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="Activities">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Azure.Analytics.Synapse.Artifacts.Models.Activity> Activities { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Azure.Analytics.Synapse.Artifacts.Models.Activity> Activities" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.UntilActivity.Activities" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Activities As IList(Of Activity)" />
<MemberSignature Language="F#" Value="member this.Activities : System.Collections.Generic.IList<Azure.Analytics.Synapse.Artifacts.Models.Activity>" Usage="Azure.Analytics.Synapse.Artifacts.Models.UntilActivity.Activities" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Azure.Analytics.Synapse.Artifacts.Models.Activity></ReturnType>
</ReturnValue>
<Docs>
<summary>
List of activities to execute.
Please note <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.Activity" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
The available derived classes include <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AppendVariableActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AzureDataExplorerCommandActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AzureFunctionActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AzureMLBatchExecutionActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AzureMLExecutePipelineActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.AzureMLUpdateResourceActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ControlActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.CopyActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.CustomActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.DatabricksNotebookActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.DatabricksSparkJarActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.DatabricksSparkPythonActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.DataLakeAnalyticsUsqlActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.DeleteActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ExecuteDataFlowActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ExecutePipelineActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ExecuteSsisPackageActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ExecutionActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.FailActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.FilterActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ForEachActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.GetMetadataActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.HDInsightHiveActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.HDInsightMapReduceActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.HDInsightPigActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.HDInsightSparkActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.HDInsightStreamingActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.IfConditionActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.LookupActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ScriptActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SetVariableActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SynapseSparkJobDefinitionActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SqlPoolStoredProcedureActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SqlServerStoredProcedureActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SwitchActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.SynapseNotebookActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.UntilActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.ValidationActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.WaitActivity" />, <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.WebActivity" /> and <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.WebHookActivity" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Expression">
<MemberSignature Language="C#" Value="public Azure.Analytics.Synapse.Artifacts.Models.Expression Expression { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Analytics.Synapse.Artifacts.Models.Expression Expression" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.UntilActivity.Expression" />
<MemberSignature Language="VB.NET" Value="Public Property Expression As Expression" />
<MemberSignature Language="F#" Value="member this.Expression : Azure.Analytics.Synapse.Artifacts.Models.Expression with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.UntilActivity.Expression" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Analytics.Synapse.Artifacts.Models.Expression</ReturnType>
</ReturnValue>
<Docs>
<summary> An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Timeout">
<MemberSignature Language="C#" Value="public object Timeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Timeout" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.UntilActivity.Timeout" />
<MemberSignature Language="VB.NET" Value="Public Property Timeout As Object" />
<MemberSignature Language="F#" Value="member this.Timeout : obj with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.UntilActivity.Timeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary> Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>