-
Notifications
You must be signed in to change notification settings - Fork 254
/
CosmosDbMongoDbApiSource.xml
273 lines (273 loc) · 17.1 KB
/
CosmosDbMongoDbApiSource.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
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
265
266
267
268
269
270
271
272
273
<Type Name="CosmosDbMongoDbApiSource" FullName="Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource">
<TypeSignature Language="C#" Value="public class CosmosDbMongoDbApiSource : Microsoft.Azure.Management.DataFactory.Models.CopySource" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CosmosDbMongoDbApiSource extends Microsoft.Azure.Management.DataFactory.Models.CopySource" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource" />
<TypeSignature Language="VB.NET" Value="Public Class CosmosDbMongoDbApiSource
Inherits CopySource" />
<TypeSignature Language="F#" Value="type CosmosDbMongoDbApiSource = class
 inherit CopySource" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.DataFactory</AssemblyName>
<AssemblyVersion>4.17.1.0</AssemblyVersion>
<AssemblyVersion>4.18.0.0</AssemblyVersion>
<AssemblyVersion>4.19.0.0</AssemblyVersion>
<AssemblyVersion>4.20.0.0</AssemblyVersion>
<AssemblyVersion>4.21.0.0</AssemblyVersion>
<AssemblyVersion>4.22.0.0</AssemblyVersion>
<AssemblyVersion>4.23.0.0</AssemblyVersion>
<AssemblyVersion>4.24.0.0</AssemblyVersion>
<AssemblyVersion>4.25.0.0</AssemblyVersion>
<AssemblyVersion>4.26.0.0</AssemblyVersion>
<AssemblyVersion>4.27.0.0</AssemblyVersion>
<AssemblyVersion>4.28.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>5.1.0.0</AssemblyVersion>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
<AssemblyVersion>5.4.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Management.DataFactory.Models.CopySource</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A copy activity source for a CosmosDB (MongoDB API) database.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CosmosDbMongoDbApiSource ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.DataFactory</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the CosmosDbMongoDbApiSource class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CosmosDbMongoDbApiSource (System.Collections.Generic.IDictionary<string,object> additionalProperties = default, object sourceRetryCount = default, object sourceRetryWait = default, object maxConcurrentConnections = default, object disableMetricsCollection = default, object filter = default, Microsoft.Azure.Management.DataFactory.Models.MongoDbCursorMethodsProperties cursorMethods = default, object batchSize = default, object queryTimeout = default, object additionalColumns = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IDictionary`2<string, object> additionalProperties, object sourceRetryCount, object sourceRetryWait, object maxConcurrentConnections, object disableMetricsCollection, object filter, class Microsoft.Azure.Management.DataFactory.Models.MongoDbCursorMethodsProperties cursorMethods, object batchSize, object queryTimeout, object additionalColumns) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource.#ctor(System.Collections.Generic.IDictionary{System.String,System.Object},System.Object,System.Object,System.Object,System.Object,System.Object,Microsoft.Azure.Management.DataFactory.Models.MongoDbCursorMethodsProperties,System.Object,System.Object,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional additionalProperties As IDictionary(Of String, Object) = Nothing, Optional sourceRetryCount As Object = Nothing, Optional sourceRetryWait As Object = Nothing, Optional maxConcurrentConnections As Object = Nothing, Optional disableMetricsCollection As Object = Nothing, Optional filter As Object = Nothing, Optional cursorMethods As MongoDbCursorMethodsProperties = Nothing, Optional batchSize As Object = Nothing, Optional queryTimeout As Object = Nothing, Optional additionalColumns As Object = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource : System.Collections.Generic.IDictionary<string, obj> * obj * obj * obj * obj * obj * Microsoft.Azure.Management.DataFactory.Models.MongoDbCursorMethodsProperties * obj * obj * obj -> Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource" Usage="new Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource (additionalProperties, sourceRetryCount, sourceRetryWait, maxConcurrentConnections, disableMetricsCollection, filter, cursorMethods, batchSize, queryTimeout, additionalColumns)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.DataFactory</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="additionalProperties" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
<Parameter Name="sourceRetryCount" Type="System.Object" />
<Parameter Name="sourceRetryWait" Type="System.Object" />
<Parameter Name="maxConcurrentConnections" Type="System.Object" />
<Parameter Name="disableMetricsCollection" Type="System.Object" />
<Parameter Name="filter" Type="System.Object" />
<Parameter Name="cursorMethods" Type="Microsoft.Azure.Management.DataFactory.Models.MongoDbCursorMethodsProperties" />
<Parameter Name="batchSize" Type="System.Object" />
<Parameter Name="queryTimeout" Type="System.Object" />
<Parameter Name="additionalColumns" Type="System.Object" />
</Parameters>
<Docs>
<param name="additionalProperties">Unmatched properties from the
message are deserialized this collection</param>
<param name="sourceRetryCount">Source retry count. Type: integer
(or Expression with resultType integer).</param>
<param name="sourceRetryWait">Source retry wait. Type: string (or
Expression with resultType string), pattern:
((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).</param>
<param name="maxConcurrentConnections">The maximum concurrent
connection count for the source data store. Type: integer (or
Expression with resultType integer).</param>
<param name="disableMetricsCollection">If true, disable data store
metrics collection. Default is false. Type: boolean (or Expression
with resultType boolean).</param>
<param name="filter">Specifies selection filter using query
operators. To return all documents in a collection, omit this
parameter or pass an empty document ({}). Type: string (or
Expression with resultType string).</param>
<param name="cursorMethods">Cursor methods for Mongodb
query.</param>
<param name="batchSize">Specifies the number of documents to return
in each batch of the response from MongoDB instance. In most cases,
modifying the batch size will not affect the user or the
application. This property's main purpose is to avoid hit the
limitation of response size. Type: integer (or Expression with
resultType integer).</param>
<param name="queryTimeout">Query timeout. Type: string (or
Expression with resultType string), pattern:
((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).</param>
<param name="additionalColumns">Specifies the additional columns to
be added to source data. Type: array of objects(AdditionalColumns)
(or Expression with resultType array of objects).</param>
<summary>
Initializes a new instance of the CosmosDbMongoDbApiSource class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AdditionalColumns">
<MemberSignature Language="C#" Value="public object AdditionalColumns { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object AdditionalColumns" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource.AdditionalColumns" />
<MemberSignature Language="VB.NET" Value="Public Property AdditionalColumns As Object" />
<MemberSignature Language="F#" Value="member this.AdditionalColumns : obj with get, set" Usage="Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource.AdditionalColumns" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.DataFactory</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="additionalColumns")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="additionalColumns")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets specifies the additional columns to be added to source
data. Type: array of objects(AdditionalColumns) (or Expression with
resultType array of objects).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BatchSize">
<MemberSignature Language="C#" Value="public object BatchSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object BatchSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource.BatchSize" />
<MemberSignature Language="VB.NET" Value="Public Property BatchSize As Object" />
<MemberSignature Language="F#" Value="member this.BatchSize : obj with get, set" Usage="Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource.BatchSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.DataFactory</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="batchSize")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="batchSize")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets specifies the number of documents to return in each
batch of the response from MongoDB instance. In most cases,
modifying the batch size will not affect the user or the
application. This property's main purpose is to avoid hit the
limitation of response size. Type: integer (or Expression with
resultType integer).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CursorMethods">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.DataFactory.Models.MongoDbCursorMethodsProperties CursorMethods { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Management.DataFactory.Models.MongoDbCursorMethodsProperties CursorMethods" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource.CursorMethods" />
<MemberSignature Language="VB.NET" Value="Public Property CursorMethods As MongoDbCursorMethodsProperties" />
<MemberSignature Language="F#" Value="member this.CursorMethods : Microsoft.Azure.Management.DataFactory.Models.MongoDbCursorMethodsProperties with get, set" Usage="Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource.CursorMethods" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.DataFactory</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="cursorMethods")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="cursorMethods")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Management.DataFactory.Models.MongoDbCursorMethodsProperties</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets cursor methods for Mongodb query.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Filter">
<MemberSignature Language="C#" Value="public object Filter { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Filter" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource.Filter" />
<MemberSignature Language="VB.NET" Value="Public Property Filter As Object" />
<MemberSignature Language="F#" Value="member this.Filter : obj with get, set" Usage="Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource.Filter" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.DataFactory</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="filter")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="filter")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets specifies selection filter using query operators. To
return all documents in a collection, omit this parameter or pass
an empty document ({}). Type: string (or Expression with resultType
string).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="QueryTimeout">
<MemberSignature Language="C#" Value="public object QueryTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object QueryTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource.QueryTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property QueryTimeout As Object" />
<MemberSignature Language="F#" Value="member this.QueryTimeout : obj with get, set" Usage="Microsoft.Azure.Management.DataFactory.Models.CosmosDbMongoDbApiSource.QueryTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.DataFactory</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="queryTimeout")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="queryTimeout")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets query timeout. 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>