-
Notifications
You must be signed in to change notification settings - Fork 256
/
ITableEntity.xml
203 lines (203 loc) · 13.8 KB
/
ITableEntity.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
<Type Name="ITableEntity" FullName="Microsoft.Azure.Cosmos.Table.ITableEntity">
<TypeSignature Language="C#" Value="public interface ITableEntity" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ITableEntity" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.Table.ITableEntity" />
<TypeSignature Language="VB.NET" Value="Public Interface ITableEntity" />
<TypeSignature Language="F#" Value="type ITableEntity = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table</AssemblyName>
<AssemblyVersion>1.0.8.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
An interface required for table entity types. The <see cref="T:Microsoft.Azure.Cosmos.Table.ITableEntity" /> interface declares getter and setter methods for the mandatory entity properties, and <see cref="M:Microsoft.Azure.Cosmos.Table.ITableEntity.ReadEntity(System.Collections.Generic.IDictionary{System.String,Microsoft.Azure.Cosmos.Table.EntityProperty},Microsoft.Azure.Cosmos.Table.OperationContext)" />
and <see cref="M:Microsoft.Azure.Cosmos.Table.ITableEntity.WriteEntity(Microsoft.Azure.Cosmos.Table.OperationContext)" /> methods for serialization and de-serialization of all entity properties using a property dictionary. Create classes implementing <see cref="T:Microsoft.Azure.Cosmos.Table.ITableEntity" /> to customize property
storage, retrieval, serialization and de-serialization, and to provide additional custom logic for a table entity.
</summary>
<remarks>
<para>The storage client library includes two implementations of <see cref="T:Microsoft.Azure.Cosmos.Table.ITableEntity" /> that provide for simple property access and serialization:</para>
<para>
<see cref="T:Microsoft.Azure.Cosmos.Table.DynamicTableEntity" /> implements <see cref="T:Microsoft.Azure.Cosmos.Table.ITableEntity" /> and provides a simple property dictionary to store and retrieve properties. Use a <see cref="T:Microsoft.Azure.Cosmos.Table.DynamicTableEntity" /> for simple access
to entity properties when only a subset of properties are returned (for example, by a select clause in a query), or for scenarios where your query can return multiple entity types
with different properties. You can also use this type to perform bulk table updates of heterogeneous entities without losing property information.</para>
<para>
<see cref="T:Microsoft.Azure.Cosmos.Table.TableEntity" /> is an implementation of <see cref="T:Microsoft.Azure.Cosmos.Table.ITableEntity" /> that uses reflection-based serialization and de-serialization behavior in its <see cref="M:Microsoft.Azure.Cosmos.Table.TableEntity.ReadEntity(System.Collections.Generic.IDictionary{System.String,Microsoft.Azure.Cosmos.Table.EntityProperty},Microsoft.Azure.Cosmos.Table.OperationContext)" /> and <see cref="M:Microsoft.Azure.Cosmos.Table.TableEntity.WriteEntity(Microsoft.Azure.Cosmos.Table.OperationContext)" /> methods.
<see cref="T:Microsoft.Azure.Cosmos.Table.TableEntity" />-derived classes with methods that follow a convention for types and naming are serialized and deserialized automatically. <see cref="T:Microsoft.Azure.Cosmos.Table.TableEntity" />-derived classes must also provide a get-able and set-able public
property of a type that is supported by the Microsoft Azure Table service.</para>
</remarks>
</Docs>
<Members>
<Member MemberName="ETag">
<MemberSignature Language="C#" Value="public string ETag { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ETag" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Table.ITableEntity.ETag" />
<MemberSignature Language="VB.NET" Value="Public Property ETag As String" />
<MemberSignature Language="F#" Value="member this.ETag : string with get, set" Usage="Microsoft.Azure.Cosmos.Table.ITableEntity.ETag" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table</AssemblyName>
<AssemblyVersion>1.0.8.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the entity's current ETag. Set this value to '*'
in order to blindly overwrite an entity as part of an update
operation.
</summary>
<value>The entity's timestamp.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PartitionKey">
<MemberSignature Language="C#" Value="public string PartitionKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PartitionKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Table.ITableEntity.PartitionKey" />
<MemberSignature Language="VB.NET" Value="Public Property PartitionKey As String" />
<MemberSignature Language="F#" Value="member this.PartitionKey : string with get, set" Usage="Microsoft.Azure.Cosmos.Table.ITableEntity.PartitionKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table</AssemblyName>
<AssemblyVersion>1.0.8.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the entity's partition key.
</summary>
<value>The entity's partition key.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadEntity">
<MemberSignature Language="C#" Value="public void ReadEntity (System.Collections.Generic.IDictionary<string,Microsoft.Azure.Cosmos.Table.EntityProperty> properties, Microsoft.Azure.Cosmos.Table.OperationContext operationContext);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void ReadEntity(class System.Collections.Generic.IDictionary`2<string, class Microsoft.Azure.Cosmos.Table.EntityProperty> properties, class Microsoft.Azure.Cosmos.Table.OperationContext operationContext) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Table.ITableEntity.ReadEntity(System.Collections.Generic.IDictionary{System.String,Microsoft.Azure.Cosmos.Table.EntityProperty},Microsoft.Azure.Cosmos.Table.OperationContext)" />
<MemberSignature Language="VB.NET" Value="Public Sub ReadEntity (properties As IDictionary(Of String, EntityProperty), operationContext As OperationContext)" />
<MemberSignature Language="F#" Value="abstract member ReadEntity : System.Collections.Generic.IDictionary<string, Microsoft.Azure.Cosmos.Table.EntityProperty> * Microsoft.Azure.Cosmos.Table.OperationContext -> unit" Usage="iTableEntity.ReadEntity (properties, operationContext)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table</AssemblyName>
<AssemblyVersion>1.0.8.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="properties" Type="System.Collections.Generic.IDictionary<System.String,Microsoft.Azure.Cosmos.Table.EntityProperty>" />
<Parameter Name="operationContext" Type="Microsoft.Azure.Cosmos.Table.OperationContext" />
</Parameters>
<Docs>
<param name="properties">The dictionary of string property names to <see cref="T:Microsoft.Azure.Cosmos.Table.EntityProperty" /> data values to deserialize and store in this table entity instance.</param>
<param name="operationContext">An <see cref="T:Microsoft.Azure.Cosmos.Table.OperationContext" /> object that represents the context for the current operation.</param>
<summary>
Populates the entity's properties from the <see cref="T:Microsoft.Azure.Cosmos.Table.EntityProperty" /> data values in the <paramref name="properties" /> dictionary.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RowKey">
<MemberSignature Language="C#" Value="public string RowKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RowKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Table.ITableEntity.RowKey" />
<MemberSignature Language="VB.NET" Value="Public Property RowKey As String" />
<MemberSignature Language="F#" Value="member this.RowKey : string with get, set" Usage="Microsoft.Azure.Cosmos.Table.ITableEntity.RowKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table</AssemblyName>
<AssemblyVersion>1.0.8.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the entity's row key.
</summary>
<value>The entity's row key.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Timestamp">
<MemberSignature Language="C#" Value="public DateTimeOffset Timestamp { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset Timestamp" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Table.ITableEntity.Timestamp" />
<MemberSignature Language="VB.NET" Value="Public Property Timestamp As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.Timestamp : DateTimeOffset with get, set" Usage="Microsoft.Azure.Cosmos.Table.ITableEntity.Timestamp" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table</AssemblyName>
<AssemblyVersion>1.0.8.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the entity's timestamp.
</summary>
<value>The entity's timestamp. The property is populated by the Microsoft Azure Table Service.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WriteEntity">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,Microsoft.Azure.Cosmos.Table.EntityProperty> WriteEntity (Microsoft.Azure.Cosmos.Table.OperationContext operationContext);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IDictionary`2<string, class Microsoft.Azure.Cosmos.Table.EntityProperty> WriteEntity(class Microsoft.Azure.Cosmos.Table.OperationContext operationContext) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Table.ITableEntity.WriteEntity(Microsoft.Azure.Cosmos.Table.OperationContext)" />
<MemberSignature Language="VB.NET" Value="Public Function WriteEntity (operationContext As OperationContext) As IDictionary(Of String, EntityProperty)" />
<MemberSignature Language="F#" Value="abstract member WriteEntity : Microsoft.Azure.Cosmos.Table.OperationContext -> System.Collections.Generic.IDictionary<string, Microsoft.Azure.Cosmos.Table.EntityProperty>" Usage="iTableEntity.WriteEntity operationContext" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table</AssemblyName>
<AssemblyVersion>1.0.8.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Table.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,Microsoft.Azure.Cosmos.Table.EntityProperty></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operationContext" Type="Microsoft.Azure.Cosmos.Table.OperationContext" />
</Parameters>
<Docs>
<param name="operationContext">An <see cref="T:Microsoft.Azure.Cosmos.Table.OperationContext" /> object that represents the context for the current operation.</param>
<summary>
Serializes the <see cref="T:System.Collections.Generic.IDictionary`2" /> of property names mapped to <see cref="T:Microsoft.Azure.Cosmos.Table.EntityProperty" /> data values from the entity instance.
</summary>
<returns>An <see cref="T:System.Collections.Generic.IDictionary`2" /> object of property names to <see cref="T:Microsoft.Azure.Cosmos.Table.EntityProperty" /> data typed values created by serializing this table entity instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>