-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.azure.analytics.synapse.artifacts.models.PipelineResource.yml
264 lines (264 loc) · 22.2 KB
/
com.azure.analytics.synapse.artifacts.models.PipelineResource.yml
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
### YamlMime:JavaType
uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource"
name: "PipelineResource"
nameWithType: "PipelineResource"
summary: "Pipeline resource type."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Resource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.AzureEntityResource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.SubResource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.analytics.synapse.artifacts.models.AzureEntityResource?alt=com.azure.analytics.synapse.artifacts.models.AzureEntityResource&text=AzureEntityResource\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.AzureEntityResource.getEtag()?alt=com.azure.analytics.synapse.artifacts.models.AzureEntityResource.getEtag&text=getEtag\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"com.azure.analytics.synapse.artifacts.models.Resource?alt=com.azure.analytics.synapse.artifacts.models.Resource&text=Resource\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Resource.getId()?alt=com.azure.analytics.synapse.artifacts.models.Resource.getId&text=getId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Resource.getName()?alt=com.azure.analytics.synapse.artifacts.models.Resource.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Resource.getType()?alt=com.azure.analytics.synapse.artifacts.models.Resource.getType&text=getType\" data-throw-if-not-resolved=\"False\" />"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **PipelineResource**</br> extends <xref href=\"com.azure.analytics.synapse.artifacts.models.SubResource?alt=com.azure.analytics.synapse.artifacts.models.SubResource&text=SubResource\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.PipelineResource()"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.PipelineResource()"
name: "PipelineResource()"
nameWithType: "PipelineResource.PipelineResource()"
summary: "Creates an instance of Pipeline<wbr>Resource class."
syntax: "public PipelineResource()"
desc: "Creates an instance of PipelineResource class."
methods:
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getActivities()"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getActivities()"
name: "getActivities()"
nameWithType: "PipelineResource.getActivities()"
summary: "Get the activities property: List of activities in pipeline."
syntax: "public List<Activity> getActivities()"
desc: "Get the activities property: List of activities in pipeline."
returns:
description: "the activities value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.analytics.synapse.artifacts.models.Activity?alt=com.azure.analytics.synapse.artifacts.models.Activity&text=Activity\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getAdditionalProperties()"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getAdditionalProperties()"
name: "getAdditionalProperties()"
nameWithType: "PipelineResource.getAdditionalProperties()"
summary: "Get the additional<wbr>Properties property: Pipeline resource type."
syntax: "public Map<String,Object> getAdditionalProperties()"
desc: "Get the additionalProperties property: Pipeline resource type."
returns:
description: "the additionalProperties value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getAnnotations()"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getAnnotations()"
name: "getAnnotations()"
nameWithType: "PipelineResource.getAnnotations()"
summary: "Get the annotations property: List of tags that can be used for describing the Pipeline."
syntax: "public List<Object> getAnnotations()"
desc: "Get the annotations property: List of tags that can be used for describing the Pipeline."
returns:
description: "the annotations value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getConcurrency()"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getConcurrency()"
name: "getConcurrency()"
nameWithType: "PipelineResource.getConcurrency()"
summary: "Get the concurrency property: The max number of concurrent runs for the pipeline."
syntax: "public Integer getConcurrency()"
desc: "Get the concurrency property: The max number of concurrent runs for the pipeline."
returns:
description: "the concurrency value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getDescription()"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getDescription()"
name: "getDescription()"
nameWithType: "PipelineResource.getDescription()"
summary: "Get the description property: The description of the pipeline."
syntax: "public String getDescription()"
desc: "Get the description property: The description of the pipeline."
returns:
description: "the description value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getFolder()"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getFolder()"
name: "getFolder()"
nameWithType: "PipelineResource.getFolder()"
summary: "Get the folder property: The folder that this Pipeline is in."
syntax: "public PipelineFolder getFolder()"
desc: "Get the folder property: The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level."
returns:
description: "the folder value."
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.PipelineFolder?alt=com.azure.analytics.synapse.artifacts.models.PipelineFolder&text=PipelineFolder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getParameters()"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getParameters()"
name: "getParameters()"
nameWithType: "PipelineResource.getParameters()"
summary: "Get the parameters property: List of parameters for pipeline."
syntax: "public Map<String,ParameterSpecification> getParameters()"
desc: "Get the parameters property: List of parameters for pipeline."
returns:
description: "the parameters value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.analytics.synapse.artifacts.models.ParameterSpecification?alt=com.azure.analytics.synapse.artifacts.models.ParameterSpecification&text=ParameterSpecification\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getRunDimensions()"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getRunDimensions()"
name: "getRunDimensions()"
nameWithType: "PipelineResource.getRunDimensions()"
summary: "Get the run<wbr>Dimensions property: Dimensions emitted by Pipeline."
syntax: "public Map<String,Object> getRunDimensions()"
desc: "Get the runDimensions property: Dimensions emitted by Pipeline."
returns:
description: "the runDimensions value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getVariables()"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.getVariables()"
name: "getVariables()"
nameWithType: "PipelineResource.getVariables()"
summary: "Get the variables property: List of variables for pipeline."
syntax: "public Map<String,VariableSpecification> getVariables()"
desc: "Get the variables property: List of variables for pipeline."
returns:
description: "the variables value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.analytics.synapse.artifacts.models.VariableSpecification?alt=com.azure.analytics.synapse.artifacts.models.VariableSpecification&text=VariableSpecification\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setActivities(java.util.List<com.azure.analytics.synapse.artifacts.models.Activity>)"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setActivities(List<Activity> activities)"
name: "setActivities(List<Activity> activities)"
nameWithType: "PipelineResource.setActivities(List<Activity> activities)"
summary: "Set the activities property: List of activities in pipeline."
parameters:
- description: "the activities value to set."
name: "activities"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.analytics.synapse.artifacts.models.Activity?alt=com.azure.analytics.synapse.artifacts.models.Activity&text=Activity\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public PipelineResource setActivities(List<Activity> activities)"
desc: "Set the activities property: List of activities in pipeline."
returns:
description: "the PipelineResource object itself."
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.PipelineResource?alt=com.azure.analytics.synapse.artifacts.models.PipelineResource&text=PipelineResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setAdditionalProperties(java.util.Map<java.lang.String,java.lang.Object>)"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setAdditionalProperties(Map<String,Object> additionalProperties)"
name: "setAdditionalProperties(Map<String,Object> additionalProperties)"
nameWithType: "PipelineResource.setAdditionalProperties(Map<String,Object> additionalProperties)"
summary: "Set the additional<wbr>Properties property: Pipeline resource type."
parameters:
- description: "the additionalProperties value to set."
name: "additionalProperties"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
syntax: "public PipelineResource setAdditionalProperties(Map<String,Object> additionalProperties)"
desc: "Set the additionalProperties property: Pipeline resource type."
returns:
description: "the PipelineResource object itself."
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.PipelineResource?alt=com.azure.analytics.synapse.artifacts.models.PipelineResource&text=PipelineResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setAnnotations(java.util.List<java.lang.Object>)"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setAnnotations(List<Object> annotations)"
name: "setAnnotations(List<Object> annotations)"
nameWithType: "PipelineResource.setAnnotations(List<Object> annotations)"
summary: "Set the annotations property: List of tags that can be used for describing the Pipeline."
parameters:
- description: "the annotations value to set."
name: "annotations"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
syntax: "public PipelineResource setAnnotations(List<Object> annotations)"
desc: "Set the annotations property: List of tags that can be used for describing the Pipeline."
returns:
description: "the PipelineResource object itself."
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.PipelineResource?alt=com.azure.analytics.synapse.artifacts.models.PipelineResource&text=PipelineResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setConcurrency(java.lang.Integer)"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setConcurrency(Integer concurrency)"
name: "setConcurrency(Integer concurrency)"
nameWithType: "PipelineResource.setConcurrency(Integer concurrency)"
summary: "Set the concurrency property: The max number of concurrent runs for the pipeline."
parameters:
- description: "the concurrency value to set."
name: "concurrency"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public PipelineResource setConcurrency(Integer concurrency)"
desc: "Set the concurrency property: The max number of concurrent runs for the pipeline."
returns:
description: "the PipelineResource object itself."
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.PipelineResource?alt=com.azure.analytics.synapse.artifacts.models.PipelineResource&text=PipelineResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setDescription(java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setDescription(String description)"
name: "setDescription(String description)"
nameWithType: "PipelineResource.setDescription(String description)"
summary: "Set the description property: The description of the pipeline."
parameters:
- description: "the description value to set."
name: "description"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PipelineResource setDescription(String description)"
desc: "Set the description property: The description of the pipeline."
returns:
description: "the PipelineResource object itself."
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.PipelineResource?alt=com.azure.analytics.synapse.artifacts.models.PipelineResource&text=PipelineResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setFolder(com.azure.analytics.synapse.artifacts.models.PipelineFolder)"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setFolder(PipelineFolder folder)"
name: "setFolder(PipelineFolder folder)"
nameWithType: "PipelineResource.setFolder(PipelineFolder folder)"
summary: "Set the folder property: The folder that this Pipeline is in."
parameters:
- description: "the folder value to set."
name: "folder"
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.PipelineFolder?alt=com.azure.analytics.synapse.artifacts.models.PipelineFolder&text=PipelineFolder\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PipelineResource setFolder(PipelineFolder folder)"
desc: "Set the folder property: The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level."
returns:
description: "the PipelineResource object itself."
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.PipelineResource?alt=com.azure.analytics.synapse.artifacts.models.PipelineResource&text=PipelineResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setParameters(java.util.Map<java.lang.String,com.azure.analytics.synapse.artifacts.models.ParameterSpecification>)"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setParameters(Map<String,ParameterSpecification> parameters)"
name: "setParameters(Map<String,ParameterSpecification> parameters)"
nameWithType: "PipelineResource.setParameters(Map<String,ParameterSpecification> parameters)"
summary: "Set the parameters property: List of parameters for pipeline."
parameters:
- description: "the parameters value to set."
name: "parameters"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.analytics.synapse.artifacts.models.ParameterSpecification?alt=com.azure.analytics.synapse.artifacts.models.ParameterSpecification&text=ParameterSpecification\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public PipelineResource setParameters(Map<String,ParameterSpecification> parameters)"
desc: "Set the parameters property: List of parameters for pipeline."
returns:
description: "the PipelineResource object itself."
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.PipelineResource?alt=com.azure.analytics.synapse.artifacts.models.PipelineResource&text=PipelineResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setRunDimensions(java.util.Map<java.lang.String,java.lang.Object>)"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setRunDimensions(Map<String,Object> runDimensions)"
name: "setRunDimensions(Map<String,Object> runDimensions)"
nameWithType: "PipelineResource.setRunDimensions(Map<String,Object> runDimensions)"
summary: "Set the run<wbr>Dimensions property: Dimensions emitted by Pipeline."
parameters:
- description: "the runDimensions value to set."
name: "runDimensions"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
syntax: "public PipelineResource setRunDimensions(Map<String,Object> runDimensions)"
desc: "Set the runDimensions property: Dimensions emitted by Pipeline."
returns:
description: "the PipelineResource object itself."
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.PipelineResource?alt=com.azure.analytics.synapse.artifacts.models.PipelineResource&text=PipelineResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setVariables(java.util.Map<java.lang.String,com.azure.analytics.synapse.artifacts.models.VariableSpecification>)"
fullName: "com.azure.analytics.synapse.artifacts.models.PipelineResource.setVariables(Map<String,VariableSpecification> variables)"
name: "setVariables(Map<String,VariableSpecification> variables)"
nameWithType: "PipelineResource.setVariables(Map<String,VariableSpecification> variables)"
summary: "Set the variables property: List of variables for pipeline."
parameters:
- description: "the variables value to set."
name: "variables"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.analytics.synapse.artifacts.models.VariableSpecification?alt=com.azure.analytics.synapse.artifacts.models.VariableSpecification&text=VariableSpecification\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public PipelineResource setVariables(Map<String,VariableSpecification> variables)"
desc: "Set the variables property: List of variables for pipeline."
returns:
description: "the PipelineResource object itself."
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.PipelineResource?alt=com.azure.analytics.synapse.artifacts.models.PipelineResource&text=PipelineResource\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Pipeline resource type."
metadata: {}
package: "com.azure.analytics.synapse.artifacts.models"
artifact: com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.15