xml/Azure.Messaging.EventHubs.Producer/PartitionPublishingOptions.xml

<Type Name="PartitionPublishingOptions" FullName="Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions">
  <TypeSignature Language="C#" Value="public class PartitionPublishingOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PartitionPublishingOptions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class PartitionPublishingOptions" />
  <TypeSignature Language="F#" Value="type PartitionPublishingOptions = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
    <AssemblyVersion>5.7.0.0</AssemblyVersion>
    <AssemblyVersion>5.7.1.0</AssemblyVersion>
    <AssemblyVersion>5.7.2.0</AssemblyVersion>
    <AssemblyVersion>5.7.3.0</AssemblyVersion>
    <AssemblyVersion>5.7.4.0</AssemblyVersion>
    <AssemblyVersion>5.7.5.0</AssemblyVersion>
    <AssemblyVersion>5.8.0.0</AssemblyVersion>
    <AssemblyVersion>5.8.1.0</AssemblyVersion>
    <AssemblyVersion>5.9.0.0</AssemblyVersion>
    <AssemblyVersion>5.9.1.0</AssemblyVersion>
    <AssemblyVersion>5.9.2.0</AssemblyVersion>
    <AssemblyVersion>5.9.3.0</AssemblyVersion>
    <AssemblyVersion>5.10.0.0</AssemblyVersion>
    <AssemblyVersion>5.11.0.0</AssemblyVersion>
    <AssemblyVersion>5.11.1.0</AssemblyVersion>
    <AssemblyVersion>5.11.2.0</AssemblyVersion>
    <AssemblyVersion>5.11.3.0</AssemblyVersion>
    <AssemblyVersion>5.11.4.0</AssemblyVersion>
    <AssemblyVersion>5.11.5.0</AssemblyVersion>
    <AssemblyVersion>5.11.6.0</AssemblyVersion>
    <AssemblyVersion>5.12.0.0</AssemblyVersion>
    <AssemblyVersion>5.12.1.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
               The set of options that can be specified for an <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" />
               to influence its behavior when publishing directly to an Event Hub partition.
             </summary>
    <remarks>
               These options are ignored when publishing to the Event Hubs gateway for automatic
               routing or when using a partition key.
             </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public PartitionPublishingOptions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
        <AssemblyVersion>5.12.0.0</AssemblyVersion>
        <AssemblyVersion>5.12.1.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions.Equals(System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
      <MemberSignature Language="F#" Value="override this.Equals : obj -&gt; bool" Usage="partitionPublishingOptions.Equals obj" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
        <AssemblyVersion>5.12.0.0</AssemblyVersion>
        <AssemblyVersion>5.12.1.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="obj" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
        <summary>
               Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
             </summary>
        <returns>
          <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetHashCode">
      <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions.GetHashCode" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
      <MemberSignature Language="F#" Value="override this.GetHashCode : unit -&gt; int" Usage="partitionPublishingOptions.GetHashCode " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
        <AssemblyVersion>5.12.0.0</AssemblyVersion>
        <AssemblyVersion>5.12.1.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
               Returns a hash code for this instance.
             </summary>
        <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OwnerLevel">
      <MemberSignature Language="C#" Value="public short? OwnerLevel { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int16&gt; OwnerLevel" />
      <MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions.OwnerLevel" />
      <MemberSignature Language="VB.NET" Value="Public Property OwnerLevel As Nullable(Of Short)" />
      <MemberSignature Language="F#" Value="member this.OwnerLevel : Nullable&lt;int16&gt; with get, set" Usage="Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions.OwnerLevel" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
        <AssemblyVersion>5.12.0.0</AssemblyVersion>
        <AssemblyVersion>5.12.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int16&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
               The owner level indicates that a publishing is intended to be performed exclusively for events in the
               requested partition in the context of the associated producer group.  To do so, publishing will attempt to assert ownership
               over the partition; in the case where more than one publisher in the producer group attempts to assert ownership for the same
               partition, the one having a larger <see cref="P:Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions.OwnerLevel" /> value will "win".
            
               When an owner level is specified, other exclusive publishers which have a lower owner level within the context of the same producer
               group will either not be allowed to be created or, if they already exist, will encounter an exception during the next attempted operation.  Should
               there be multiple producers in the producer group with the same owner level, each of them will be able to publish to the partition.
            
               Producers with no owner level or which belong to a different producer group are permitted to publish to the associated partition without
               restriction or awareness of other exclusive producers.
             </summary>
        <value>The relative priority to associate with an exclusive publisher; if <c>null</c>, the Event Hubs service will control the value.</value>
        <remarks>
               The owner level is only recognized and relevant when certain features of the producer are enabled.  For example, it is used by
               idempotent publishing.  The default owner level is <c>null</c>.
             </remarks>
        <altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
        <altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ProducerDisconnected" />
        <exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
               Occurs when the owner level is set and the <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" /> is unable to publish to the requested Event Hub partition due to being denied
               ownership.  In this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" /> will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ProducerDisconnected" />.
             </exception>
        <altmember cref="P:Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions.EnableIdempotentPartitions" />
      </Docs>
    </Member>
    <Member MemberName="ProducerGroupId">
      <MemberSignature Language="C#" Value="public long? ProducerGroupId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int64&gt; ProducerGroupId" />
      <MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions.ProducerGroupId" />
      <MemberSignature Language="VB.NET" Value="Public Property ProducerGroupId As Nullable(Of Long)" />
      <MemberSignature Language="F#" Value="member this.ProducerGroupId : Nullable&lt;int64&gt; with get, set" Usage="Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions.ProducerGroupId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
        <AssemblyVersion>5.12.0.0</AssemblyVersion>
        <AssemblyVersion>5.12.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int64&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
               The identifier of the producer group that this producer is associated with when publishing to the associated partition.
               Events will be published in the context of this group.
             </summary>
        <value>The identifier of the producer group to associate with the partition; if <c>null</c>, the Event Hubs service will control the value.</value>
        <remarks>
               The producer group is only recognized and relevant when certain features of the producer are enabled.  For example, it is used by
               idempotent publishing.
             </remarks>
        <altmember cref="P:Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions.EnableIdempotentPartitions" />
      </Docs>
    </Member>
    <Member MemberName="StartingSequenceNumber">
      <MemberSignature Language="C#" Value="public int? StartingSequenceNumber { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; StartingSequenceNumber" />
      <MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions.StartingSequenceNumber" />
      <MemberSignature Language="VB.NET" Value="Public Property StartingSequenceNumber As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.StartingSequenceNumber : Nullable&lt;int&gt; with get, set" Usage="Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions.StartingSequenceNumber" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
        <AssemblyVersion>5.12.0.0</AssemblyVersion>
        <AssemblyVersion>5.12.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
               The starting number that should be used for the automatic sequencing of events for the associated partition, when published by this producer.
             </summary>
        <value>
          <para>The starting sequence number to associate with the partition; if <c>null</c>, the Event Hubs service will control the value.</para>
          <para>The sequence number will be in the range of <c>0</c> - <see cref="F:System.Int32.MaxValue" /> (inclusive) and will increase as events are published.
                 When more than <see cref="F:System.Int32.MaxValue" /> events have been published, the sequence number will roll over to <c>0</c>.</para>
          <para>The default sequence number is <c>null</c>.</para>
        </value>
        <remarks>
               The starting sequence number is only recognized and relevant when certain features of the producer are enabled.  For example, it is used by
               idempotent publishing.
             </remarks>
        <altmember cref="P:Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions.EnableIdempotentPartitions" />
      </Docs>
    </Member>
    <Member MemberName="ToString">
      <MemberSignature Language="C#" Value="public override string ToString ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions.ToString" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
      <MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="partitionPublishingOptions.ToString " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
        <AssemblyVersion>5.12.0.0</AssemblyVersion>
        <AssemblyVersion>5.12.1.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
               Converts the instance to string representation.
             </summary>
        <returns>A <see cref="T:System.String" /> that represents this instance.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>