xml/Azure.ResourceManager.DurableTask/DurableTaskHubData.xml (249 lines of code) (raw):

<Type Name="DurableTaskHubData" FullName="Azure.ResourceManager.DurableTask.DurableTaskHubData"> <TypeSignature Language="C#" Value="public class DurableTaskHubData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;, System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DurableTaskHubData extends Azure.ResourceManager.Models.ResourceData implements class System.ClientModel.Primitives.IJsonModel`1&lt;class Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;, class System.ClientModel.Primitives.IPersistableModel`1&lt;class Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;" /> <TypeSignature Language="DocId" Value="T:Azure.ResourceManager.DurableTask.DurableTaskHubData" /> <TypeSignature Language="VB.NET" Value="Public Class DurableTaskHubData&#xA;Inherits ResourceData&#xA;Implements IJsonModel(Of DurableTaskHubData), IPersistableModel(Of DurableTaskHubData)" /> <TypeSignature Language="F#" Value="type DurableTaskHubData = class&#xA; inherit ResourceData&#xA; interface IJsonModel&lt;DurableTaskHubData&gt;&#xA; interface IPersistableModel&lt;DurableTaskHubData&gt;" /> <AssemblyInfo> <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>Azure.ResourceManager.Models.ResourceData</BaseTypeName> </Base> <Interfaces> <Interface> <InterfaceName>System.ClientModel.Primitives.IJsonModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;</InterfaceName> </Interface> <Interface> <InterfaceName>System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;</InterfaceName> </Interface> <Interface> <InterfaceName>System.ClientModel.Primitives.IPersistableModel&lt;T&gt;</InterfaceName> </Interface> </Interfaces> <Docs> <summary> A class representing the DurableTaskHub data model. A Task Hub resource belonging to the scheduler </summary> <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public DurableTaskHubData ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DurableTask.DurableTaskHubData.#ctor" /> <MemberSignature Language="VB.NET" Value="Public Sub New ()" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Parameters /> <Docs> <summary> Initializes a new instance of <see cref="T:Azure.ResourceManager.DurableTask.DurableTaskHubData" />. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="JsonModelWriteCore"> <MemberSignature Language="C#" Value="protected override void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void JsonModelWriteCore(class System.Text.Json.Utf8JsonWriter writer, class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DurableTask.DurableTaskHubData.JsonModelWriteCore(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)" /> <MemberSignature Language="VB.NET" Value="Protected Overrides Sub JsonModelWriteCore (writer As Utf8JsonWriter, options As ModelReaderWriterOptions)" /> <MemberSignature Language="F#" Value="abstract member JsonModelWriteCore : System.Text.Json.Utf8JsonWriter * System.ClientModel.Primitives.ModelReaderWriterOptions -&gt; unit&#xA;override this.JsonModelWriteCore : System.Text.Json.Utf8JsonWriter * System.ClientModel.Primitives.ModelReaderWriterOptions -&gt; unit" Usage="durableTaskHubData.JsonModelWriteCore (writer, options)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="writer" Type="System.Text.Json.Utf8JsonWriter" /> <Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" /> </Parameters> <Docs> <param name="writer"> The JSON writer. </param> <param name="options"> The client options for reading and writing models. </param> <summary>To be added.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Properties"> <MemberSignature Language="C#" Value="public Azure.ResourceManager.DurableTask.Models.DurableTaskHubProperties Properties { get; set; }" /> <MemberSignature Language="ILAsm" Value=".property instance class Azure.ResourceManager.DurableTask.Models.DurableTaskHubProperties Properties" /> <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.DurableTask.DurableTaskHubData.Properties" /> <MemberSignature Language="VB.NET" Value="Public Property Properties As DurableTaskHubProperties" /> <MemberSignature Language="F#" Value="member this.Properties : Azure.ResourceManager.DurableTask.Models.DurableTaskHubProperties with get, set" Usage="Azure.ResourceManager.DurableTask.DurableTaskHubData.Properties" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.ResourceManager.DurableTask.Models.DurableTaskHubProperties</ReturnType> </ReturnValue> <Docs> <summary> The resource-specific properties for this resource. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="System.ClientModel.Primitives.IJsonModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Create"> <MemberSignature Language="C#" Value="Azure.ResourceManager.DurableTask.DurableTaskHubData IJsonModel&lt;DurableTaskHubData&gt;.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);" /> <MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class Azure.ResourceManager.DurableTask.DurableTaskHubData System.ClientModel.Primitives.IJsonModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Create(valuetype System.Text.Json.Utf8JsonReader&amp; reader, class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DurableTask.DurableTaskHubData.System#ClientModel#Primitives#IJsonModel&lt;Azure#ResourceManager#DurableTask#DurableTaskHubData&gt;#Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)" /> <MemberSignature Language="VB.NET" Value="Function Create (ByRef reader As Utf8JsonReader, options As ModelReaderWriterOptions) As DurableTaskHubData Implements IJsonModel(Of DurableTaskHubData).Create" /> <MemberSignature Language="F#" Value="abstract member System.ClientModel.Primitives.IJsonModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Create : Utf8JsonReader * System.ClientModel.Primitives.ModelReaderWriterOptions -&gt; Azure.ResourceManager.DurableTask.DurableTaskHubData&#xA;override this.System.ClientModel.Primitives.IJsonModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Create : Utf8JsonReader * System.ClientModel.Primitives.ModelReaderWriterOptions -&gt; Azure.ResourceManager.DurableTask.DurableTaskHubData" Usage="durableTaskHubData.System.ClientModel.Primitives.IJsonModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Create (reader, options)" /> <MemberType>Method</MemberType> <Implements> <InterfaceMember>M:System.ClientModel.Primitives.IJsonModel`1.Create(System.Text.Json.Utf8JsonReader@,System.ClientModel.Primitives.ModelReaderWriterOptions)</InterfaceMember> </Implements> <AssemblyInfo> <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.ResourceManager.DurableTask.DurableTaskHubData</ReturnType> </ReturnValue> <Parameters> <Parameter Name="reader" Type="System.Text.Json.Utf8JsonReader" RefType="ref" /> <Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" /> </Parameters> <Docs> <param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read.</param> <param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param> <summary> Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. </summary> <returns>A <typeparamref name="T" /> representation of the JSON value.</returns> <remarks>To be added.</remarks> <exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception> </Docs> </Member> <Member MemberName="System.ClientModel.Primitives.IJsonModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Write"> <MemberSignature Language="C#" Value="void IJsonModel&lt;DurableTaskHubData&gt;.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);" /> <MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void System.ClientModel.Primitives.IJsonModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Write(class System.Text.Json.Utf8JsonWriter writer, class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DurableTask.DurableTaskHubData.System#ClientModel#Primitives#IJsonModel&lt;Azure#ResourceManager#DurableTask#DurableTaskHubData&gt;#Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)" /> <MemberSignature Language="VB.NET" Value="Sub Write (writer As Utf8JsonWriter, options As ModelReaderWriterOptions) Implements IJsonModel(Of DurableTaskHubData).Write" /> <MemberSignature Language="F#" Value="abstract member System.ClientModel.Primitives.IJsonModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Write : System.Text.Json.Utf8JsonWriter * System.ClientModel.Primitives.ModelReaderWriterOptions -&gt; unit&#xA;override this.System.ClientModel.Primitives.IJsonModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Write : System.Text.Json.Utf8JsonWriter * System.ClientModel.Primitives.ModelReaderWriterOptions -&gt; unit" Usage="durableTaskHubData.System.ClientModel.Primitives.IJsonModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Write (writer, options)" /> <MemberType>Method</MemberType> <Implements> <InterfaceMember>M:System.ClientModel.Primitives.IJsonModel`1.Write(System.Text.Json.Utf8JsonWriter,System.ClientModel.Primitives.ModelReaderWriterOptions)</InterfaceMember> </Implements> <AssemblyInfo> <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="writer" Type="System.Text.Json.Utf8JsonWriter" /> <Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" /> </Parameters> <Docs> <param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write into.</param> <param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param> <summary> Writes the model to the provided <see cref="T:System.Text.Json.Utf8JsonWriter" />. </summary> <remarks>To be added.</remarks> <exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception> </Docs> </Member> <Member MemberName="System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Create"> <MemberSignature Language="C#" Value="Azure.ResourceManager.DurableTask.DurableTaskHubData IPersistableModel&lt;DurableTaskHubData&gt;.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);" /> <MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class Azure.ResourceManager.DurableTask.DurableTaskHubData System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Create(class System.BinaryData data, class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DurableTask.DurableTaskHubData.System#ClientModel#Primitives#IPersistableModel&lt;Azure#ResourceManager#DurableTask#DurableTaskHubData&gt;#Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)" /> <MemberSignature Language="VB.NET" Value="Function Create (data As BinaryData, options As ModelReaderWriterOptions) As DurableTaskHubData Implements IPersistableModel(Of DurableTaskHubData).Create" /> <MemberSignature Language="F#" Value="abstract member System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Create : BinaryData * System.ClientModel.Primitives.ModelReaderWriterOptions -&gt; Azure.ResourceManager.DurableTask.DurableTaskHubData&#xA;override this.System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Create : BinaryData * System.ClientModel.Primitives.ModelReaderWriterOptions -&gt; Azure.ResourceManager.DurableTask.DurableTaskHubData" Usage="durableTaskHubData.System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Create (data, options)" /> <MemberType>Method</MemberType> <Implements> <InterfaceMember>M:System.ClientModel.Primitives.IPersistableModel`1.Create(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)</InterfaceMember> </Implements> <AssemblyInfo> <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.ResourceManager.DurableTask.DurableTaskHubData</ReturnType> </ReturnValue> <Parameters> <Parameter Name="data" Type="System.BinaryData" /> <Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" /> </Parameters> <Docs> <param name="data">The <see cref="T:System.BinaryData" /> to parse.</param> <param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param> <summary> Converts the provided <see cref="T:System.BinaryData" /> into a model. </summary> <returns>A <typeparamref name="T" /> representation of the data.</returns> <remarks>To be added.</remarks> <exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception> </Docs> </Member> <Member MemberName="System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.GetFormatFromOptions"> <MemberSignature Language="C#" Value="string IPersistableModel&lt;DurableTaskHubData&gt;.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);" /> <MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance string System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.GetFormatFromOptions(class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DurableTask.DurableTaskHubData.System#ClientModel#Primitives#IPersistableModel&lt;Azure#ResourceManager#DurableTask#DurableTaskHubData&gt;#GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)" /> <MemberSignature Language="VB.NET" Value="Function GetFormatFromOptions (options As ModelReaderWriterOptions) As String Implements IPersistableModel(Of DurableTaskHubData).GetFormatFromOptions" /> <MemberSignature Language="F#" Value="abstract member System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.GetFormatFromOptions : System.ClientModel.Primitives.ModelReaderWriterOptions -&gt; string&#xA;override this.System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.GetFormatFromOptions : System.ClientModel.Primitives.ModelReaderWriterOptions -&gt; string" Usage="durableTaskHubData.System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.GetFormatFromOptions options" /> <MemberType>Method</MemberType> <Implements> <InterfaceMember>M:System.ClientModel.Primitives.IPersistableModel`1.GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions)</InterfaceMember> </Implements> <AssemblyInfo> <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" /> </Parameters> <Docs> <param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to consider when serializing and deserializing the model.</param> <summary> Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. </summary> <returns>The format that the model uses when communicating with the serivce.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Write"> <MemberSignature Language="C#" Value="BinaryData IPersistableModel&lt;DurableTaskHubData&gt;.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);" /> <MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.BinaryData System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Write(class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DurableTask.DurableTaskHubData.System#ClientModel#Primitives#IPersistableModel&lt;Azure#ResourceManager#DurableTask#DurableTaskHubData&gt;#Write(System.ClientModel.Primitives.ModelReaderWriterOptions)" /> <MemberSignature Language="VB.NET" Value="Function Write (options As ModelReaderWriterOptions) As BinaryData Implements IPersistableModel(Of DurableTaskHubData).Write" /> <MemberSignature Language="F#" Value="abstract member System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Write : System.ClientModel.Primitives.ModelReaderWriterOptions -&gt; BinaryData&#xA;override this.System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Write : System.ClientModel.Primitives.ModelReaderWriterOptions -&gt; BinaryData" Usage="durableTaskHubData.System.ClientModel.Primitives.IPersistableModel&lt;Azure.ResourceManager.DurableTask.DurableTaskHubData&gt;.Write options" /> <MemberType>Method</MemberType> <Implements> <InterfaceMember>M:System.ClientModel.Primitives.IPersistableModel`1.Write(System.ClientModel.Primitives.ModelReaderWriterOptions)</InterfaceMember> </Implements> <AssemblyInfo> <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.BinaryData</ReturnType> </ReturnValue> <Parameters> <Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" /> </Parameters> <Docs> <param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param> <summary> Writes the model into a <see cref="T:System.BinaryData" />. </summary> <returns>A binary representation of the written model.</returns> <remarks>To be added.</remarks> <exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception> </Docs> </Member> </Members> </Type>