/
com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.yml
219 lines (219 loc) · 20.8 KB
/
com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.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
### YamlMime:JavaType
uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset"
name: "AzureSqlTableDataset"
nameWithType: "AzureSqlTableDataset"
summary: "The Azure SQL Server database dataset."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset?alt=com.azure.analytics.synapse.artifacts.models.Dataset&text=Dataset\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.getAdditionalProperties()?alt=com.azure.analytics.synapse.artifacts.models.Dataset.getAdditionalProperties&text=getAdditionalProperties\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.getAnnotations()?alt=com.azure.analytics.synapse.artifacts.models.Dataset.getAnnotations&text=getAnnotations\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.getDescription()?alt=com.azure.analytics.synapse.artifacts.models.Dataset.getDescription&text=getDescription\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.getFolder()?alt=com.azure.analytics.synapse.artifacts.models.Dataset.getFolder&text=getFolder\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.getLinkedServiceName()?alt=com.azure.analytics.synapse.artifacts.models.Dataset.getLinkedServiceName&text=getLinkedServiceName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.getParameters()?alt=com.azure.analytics.synapse.artifacts.models.Dataset.getParameters&text=getParameters\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.getSchema()?alt=com.azure.analytics.synapse.artifacts.models.Dataset.getSchema&text=getSchema\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.getStructure()?alt=com.azure.analytics.synapse.artifacts.models.Dataset.getStructure&text=getStructure\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.setAdditionalProperties(java.util.Map<java.lang.String,java.lang.Object>)?alt=com.azure.analytics.synapse.artifacts.models.Dataset.setAdditionalProperties&text=setAdditionalProperties\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.setAnnotations(java.util.List<java.lang.Object>)?alt=com.azure.analytics.synapse.artifacts.models.Dataset.setAnnotations&text=setAnnotations\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.setDescription(java.lang.String)?alt=com.azure.analytics.synapse.artifacts.models.Dataset.setDescription&text=setDescription\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.setFolder(com.azure.analytics.synapse.artifacts.models.DatasetFolder)?alt=com.azure.analytics.synapse.artifacts.models.Dataset.setFolder&text=setFolder\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.setLinkedServiceName(com.azure.analytics.synapse.artifacts.models.LinkedServiceReference)?alt=com.azure.analytics.synapse.artifacts.models.Dataset.setLinkedServiceName&text=setLinkedServiceName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.setParameters(java.util.Map<java.lang.String,com.azure.analytics.synapse.artifacts.models.ParameterSpecification>)?alt=com.azure.analytics.synapse.artifacts.models.Dataset.setParameters&text=setParameters\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.setSchema(java.lang.Object)?alt=com.azure.analytics.synapse.artifacts.models.Dataset.setSchema&text=setSchema\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset.setStructure(java.lang.Object)?alt=com.azure.analytics.synapse.artifacts.models.Dataset.setStructure&text=setStructure\" 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 **AzureSqlTableDataset**</br> extends <xref href=\"com.azure.analytics.synapse.artifacts.models.Dataset?alt=com.azure.analytics.synapse.artifacts.models.Dataset&text=Dataset\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.AzureSqlTableDataset()"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.AzureSqlTableDataset()"
name: "AzureSqlTableDataset()"
nameWithType: "AzureSqlTableDataset.AzureSqlTableDataset()"
summary: "Creates an instance of Azure<wbr>Sql<wbr>Table<wbr>Dataset class."
syntax: "public AzureSqlTableDataset()"
desc: "Creates an instance of AzureSqlTableDataset class."
methods:
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.getSchemaTypePropertiesSchema()"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.getSchemaTypePropertiesSchema()"
name: "getSchemaTypePropertiesSchema()"
nameWithType: "AzureSqlTableDataset.getSchemaTypePropertiesSchema()"
summary: "Get the schema<wbr>Type<wbr>Properties<wbr>Schema property: The schema name of the Azure SQL database."
syntax: "public Object getSchemaTypePropertiesSchema()"
desc: "Get the schemaTypePropertiesSchema property: The schema name of the Azure SQL database. Type: string (or Expression with resultType string)."
returns:
description: "the schemaTypePropertiesSchema value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.getTable()"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.getTable()"
name: "getTable()"
nameWithType: "AzureSqlTableDataset.getTable()"
summary: "Get the table property: The table name of the Azure SQL database."
syntax: "public Object getTable()"
desc: "Get the table property: The table name of the Azure SQL database. Type: string (or Expression with resultType string)."
returns:
description: "the table value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.getTableName()"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.getTableName()"
name: "getTableName()"
nameWithType: "AzureSqlTableDataset.getTableName()"
summary: "Get the table<wbr>Name property: This property will be retired."
syntax: "public Object getTableName()"
desc: "Get the tableName property: This property will be retired. Please consider using schema + table properties instead."
returns:
description: "the tableName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setAnnotations(java.util.List<java.lang.Object>)"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setAnnotations(List<Object> annotations)"
name: "setAnnotations(List<Object> annotations)"
nameWithType: "AzureSqlTableDataset.setAnnotations(List<Object> annotations)"
summary: "Set the annotations property: List of tags that can be used for describing the Dataset."
overridden: "com.azure.analytics.synapse.artifacts.models.Dataset.setAnnotations(java.util.List<java.lang.Object>)"
parameters:
- 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 AzureSqlTableDataset setAnnotations(List<Object> annotations)"
desc: "Set the annotations property: List of tags that can be used for describing the Dataset."
returns:
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset?alt=com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset&text=AzureSqlTableDataset\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setDescription(java.lang.String)"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setDescription(String description)"
name: "setDescription(String description)"
nameWithType: "AzureSqlTableDataset.setDescription(String description)"
summary: "Set the description property: Dataset description."
overridden: "com.azure.analytics.synapse.artifacts.models.Dataset.setDescription(java.lang.String)"
parameters:
- name: "description"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public AzureSqlTableDataset setDescription(String description)"
desc: "Set the description property: Dataset description."
returns:
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset?alt=com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset&text=AzureSqlTableDataset\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setFolder(com.azure.analytics.synapse.artifacts.models.DatasetFolder)"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setFolder(DatasetFolder folder)"
name: "setFolder(DatasetFolder folder)"
nameWithType: "AzureSqlTableDataset.setFolder(DatasetFolder folder)"
summary: "Set the folder property: The folder that this Dataset is in."
overridden: "com.azure.analytics.synapse.artifacts.models.Dataset.setFolder(com.azure.analytics.synapse.artifacts.models.DatasetFolder)"
parameters:
- name: "folder"
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.DatasetFolder?alt=com.azure.analytics.synapse.artifacts.models.DatasetFolder&text=DatasetFolder\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AzureSqlTableDataset setFolder(DatasetFolder folder)"
desc: "Set the folder property: The folder that this Dataset is in. If not specified, Dataset will appear at the root level."
returns:
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset?alt=com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset&text=AzureSqlTableDataset\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setLinkedServiceName(com.azure.analytics.synapse.artifacts.models.LinkedServiceReference)"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setLinkedServiceName(LinkedServiceReference linkedServiceName)"
name: "setLinkedServiceName(LinkedServiceReference linkedServiceName)"
nameWithType: "AzureSqlTableDataset.setLinkedServiceName(LinkedServiceReference linkedServiceName)"
summary: "Set the linked<wbr>Service<wbr>Name property: Linked service reference."
overridden: "com.azure.analytics.synapse.artifacts.models.Dataset.setLinkedServiceName(com.azure.analytics.synapse.artifacts.models.LinkedServiceReference)"
parameters:
- name: "linkedServiceName"
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.LinkedServiceReference?alt=com.azure.analytics.synapse.artifacts.models.LinkedServiceReference&text=LinkedServiceReference\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AzureSqlTableDataset setLinkedServiceName(LinkedServiceReference linkedServiceName)"
desc: "Set the linkedServiceName property: Linked service reference."
returns:
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset?alt=com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset&text=AzureSqlTableDataset\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setParameters(java.util.Map<java.lang.String,com.azure.analytics.synapse.artifacts.models.ParameterSpecification>)"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setParameters(Map<String,ParameterSpecification> parameters)"
name: "setParameters(Map<String,ParameterSpecification> parameters)"
nameWithType: "AzureSqlTableDataset.setParameters(Map<String,ParameterSpecification> parameters)"
summary: "Set the parameters property: Parameters for dataset."
overridden: "com.azure.analytics.synapse.artifacts.models.Dataset.setParameters(java.util.Map<java.lang.String,com.azure.analytics.synapse.artifacts.models.ParameterSpecification>)"
parameters:
- 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 AzureSqlTableDataset setParameters(Map<String,ParameterSpecification> parameters)"
desc: "Set the parameters property: Parameters for dataset."
returns:
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset?alt=com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset&text=AzureSqlTableDataset\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setSchema(java.lang.Object)"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setSchema(Object schema)"
name: "setSchema(Object schema)"
nameWithType: "AzureSqlTableDataset.setSchema(Object schema)"
summary: "Set the schema property: Columns that define the physical type schema of the dataset."
overridden: "com.azure.analytics.synapse.artifacts.models.Dataset.setSchema(java.lang.Object)"
parameters:
- name: "schema"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
syntax: "public AzureSqlTableDataset setSchema(Object schema)"
desc: "Set the schema property: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement."
returns:
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset?alt=com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset&text=AzureSqlTableDataset\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setSchemaTypePropertiesSchema(java.lang.Object)"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setSchemaTypePropertiesSchema(Object schemaTypePropertiesSchema)"
name: "setSchemaTypePropertiesSchema(Object schemaTypePropertiesSchema)"
nameWithType: "AzureSqlTableDataset.setSchemaTypePropertiesSchema(Object schemaTypePropertiesSchema)"
summary: "Set the schema<wbr>Type<wbr>Properties<wbr>Schema property: The schema name of the Azure SQL database."
parameters:
- description: "the schemaTypePropertiesSchema value to set."
name: "schemaTypePropertiesSchema"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
syntax: "public AzureSqlTableDataset setSchemaTypePropertiesSchema(Object schemaTypePropertiesSchema)"
desc: "Set the schemaTypePropertiesSchema property: The schema name of the Azure SQL database. Type: string (or Expression with resultType string)."
returns:
description: "the AzureSqlTableDataset object itself."
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset?alt=com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset&text=AzureSqlTableDataset\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setStructure(java.lang.Object)"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setStructure(Object structure)"
name: "setStructure(Object structure)"
nameWithType: "AzureSqlTableDataset.setStructure(Object structure)"
summary: "Set the structure property: Columns that define the structure of the dataset."
overridden: "com.azure.analytics.synapse.artifacts.models.Dataset.setStructure(java.lang.Object)"
parameters:
- name: "structure"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
syntax: "public AzureSqlTableDataset setStructure(Object structure)"
desc: "Set the structure property: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement."
returns:
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset?alt=com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset&text=AzureSqlTableDataset\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setTable(java.lang.Object)"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setTable(Object table)"
name: "setTable(Object table)"
nameWithType: "AzureSqlTableDataset.setTable(Object table)"
summary: "Set the table property: The table name of the Azure SQL database."
parameters:
- description: "the table value to set."
name: "table"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
syntax: "public AzureSqlTableDataset setTable(Object table)"
desc: "Set the table property: The table name of the Azure SQL database. Type: string (or Expression with resultType string)."
returns:
description: "the AzureSqlTableDataset object itself."
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset?alt=com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset&text=AzureSqlTableDataset\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setTableName(java.lang.Object)"
fullName: "com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset.setTableName(Object tableName)"
name: "setTableName(Object tableName)"
nameWithType: "AzureSqlTableDataset.setTableName(Object tableName)"
summary: "Set the table<wbr>Name property: This property will be retired."
parameters:
- description: "the tableName value to set."
name: "tableName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
syntax: "public AzureSqlTableDataset setTableName(Object tableName)"
desc: "Set the tableName property: This property will be retired. Please consider using schema + table properties instead."
returns:
description: "the AzureSqlTableDataset object itself."
type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset?alt=com.azure.analytics.synapse.artifacts.models.AzureSqlTableDataset&text=AzureSqlTableDataset\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The Azure SQL Server database dataset."
metadata: {}
package: "com.azure.analytics.synapse.artifacts.models"
artifact: com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.14