/
TakeSnapshotRequest.xml
222 lines (222 loc) · 12.7 KB
/
TakeSnapshotRequest.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
<Type Name="TakeSnapshotRequest" FullName="Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest">
<TypeSignature Language="C#" Value="public class TakeSnapshotRequest" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TakeSnapshotRequest extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest" />
<TypeSignature Language="VB.NET" Value="Public Class TakeSnapshotRequest" />
<TypeSignature Language="F#" Value="type TakeSnapshotRequest = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.7.0.0</AssemblyVersion>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Request body for taking snapshot operation.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TakeSnapshotRequest ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the TakeSnapshotRequest class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TakeSnapshotRequest (Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType type, string objectId, System.Collections.Generic.IList<Guid> applyScope, string userData = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType type, string objectId, class System.Collections.Generic.IList`1<valuetype System.Guid> applyScope, string userData) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest.#ctor(Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType,System.String,System.Collections.Generic.IList{System.Guid},System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (type As SnapshotObjectType, objectId As String, applyScope As IList(Of Guid), Optional userData As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest : Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType * string * System.Collections.Generic.IList<Guid> * string -> Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest" Usage="new Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest (type, objectId, applyScope, userData)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="type" Type="Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType" />
<Parameter Name="objectId" Type="System.String" />
<Parameter Name="applyScope" Type="System.Collections.Generic.IList<System.Guid>" />
<Parameter Name="userData" Type="System.String" />
</Parameters>
<Docs>
<param name="type">User specified type for the source object to
take snapshot from. Currently FaceList, PersonGroup, LargeFaceList
and LargePersonGroup are supported. Possible values include:
'FaceList', 'LargeFaceList', 'LargePersonGroup',
'PersonGroup'</param>
<param name="objectId">User specified source object id to take
snapshot from.</param>
<param name="applyScope">User specified array of target Face
subscription ids for the snapshot. For each snapshot, only
subscriptions included in the applyScope of Snapshot - Take can
apply it.</param>
<param name="userData">User specified data about the snapshot for
any purpose. Length should not exceed 16KB.</param>
<summary>
Initializes a new instance of the TakeSnapshotRequest class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ApplyScope">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Guid> ApplyScope { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<valuetype System.Guid> ApplyScope" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest.ApplyScope" />
<MemberSignature Language="VB.NET" Value="Public Property ApplyScope As IList(Of Guid)" />
<MemberSignature Language="F#" Value="member this.ApplyScope : System.Collections.Generic.IList<Guid> with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest.ApplyScope" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="applyScope")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="applyScope")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.Guid></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets user specified array of target Face subscription ids
for the snapshot. For each snapshot, only subscriptions included in
the applyScope of Snapshot - Take can apply it.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ObjectId">
<MemberSignature Language="C#" Value="public string ObjectId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ObjectId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest.ObjectId" />
<MemberSignature Language="VB.NET" Value="Public Property ObjectId As String" />
<MemberSignature Language="F#" Value="member this.ObjectId : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest.ObjectId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="objectId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="objectId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets user specified source object id to take snapshot from.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType Type { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType Type" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest.Type" />
<MemberSignature Language="VB.NET" Value="Public Property Type As SnapshotObjectType" />
<MemberSignature Language="F#" Value="member this.Type : Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest.Type" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="type")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="type")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.CognitiveServices.Vision.Face.Models.SnapshotObjectType</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets user specified type for the source object to take
snapshot from. Currently FaceList, PersonGroup, LargeFaceList and
LargePersonGroup are supported. Possible values include:
'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UserData">
<MemberSignature Language="C#" Value="public string UserData { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string UserData" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest.UserData" />
<MemberSignature Language="VB.NET" Value="Public Property UserData As String" />
<MemberSignature Language="F#" Value="member this.UserData : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest.UserData" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="userData")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="userData")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets user specified data about the snapshot for any
purpose. Length should not exceed 16KB.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public virtual void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.Models.TakeSnapshotRequest.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="takeSnapshotRequest.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validate the object.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown if validation fails
</exception>
</Docs>
</Member>
</Members>
</Type>