BlobIndexerImageAction.xml

<Type Name="BlobIndexerImageAction" FullName="Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction">
  <TypeSignature Language="C#" Value="public readonly struct BlobIndexerImageAction : IEquatable&lt;Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction&gt;" />
  <TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit BlobIndexerImageAction extends System.ValueType implements class System.IEquatable`1&lt;valuetype Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction&gt;" />
  <TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" />
  <TypeSignature Language="VB.NET" Value="Public Structure BlobIndexerImageAction&#xA;Implements IEquatable(Of BlobIndexerImageAction)" />
  <TypeSignature Language="F#" Value="type BlobIndexerImageAction = struct" />
  <AssemblyInfo>
    <AssemblyName>Azure.Search.Documents</AssemblyName>
    <AssemblyVersion>11.2.0.0</AssemblyVersion>
    <AssemblyVersion>11.2.1.0</AssemblyVersion>
    <AssemblyVersion>11.3.0.0</AssemblyVersion>
    <AssemblyVersion>11.4.0.0</AssemblyVersion>
    <AssemblyVersion>11.5.0.0</AssemblyVersion>
    <AssemblyVersion>11.5.1.0</AssemblyVersion>
    <AssemblyVersion>11.6.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ValueType</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IEquatable&lt;Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction&gt;</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary> Determines how to process embedded images and image files in Azure blob storage.  Setting the "imageAction" configuration to any value other than "none" requires that a skillset also be attached to that indexer. </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public BlobIndexerImageAction (string value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string value) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (value As String)" />
      <MemberSignature Language="F#" Value="new Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction : string -&gt; Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" Usage="new Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction value" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="value" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="value">To be added.</param>
        <summary> Initializes a new instance of <see cref="T:Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" />. </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="value" /> is null. </exception>
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public bool Equals (Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction other);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction other) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction.Equals(Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction)" />
      <MemberSignature Language="VB.NET" Value="Public Function Equals (other As BlobIndexerImageAction) As Boolean" />
      <MemberSignature Language="F#" Value="override this.Equals : Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction -&gt; bool" Usage="blobIndexerImageAction.Equals other" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.IEquatable`1.Equals(`0)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="other" Type="Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" />
      </Parameters>
      <Docs>
        <param name="other">An object to compare with this object.</param>
        <summary>Indicates whether the current object is equal to another object of the same type.</summary>
        <returns>
          <see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </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.Search.Documents.Indexes.Models.BlobIndexerImageAction.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="blobIndexerImageAction.Equals obj" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.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 object to compare with the current instance.</param>
        <summary>Indicates whether this instance and a specified object are equal.</summary>
        <returns>
          <see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="GenerateNormalizedImagePerPage">
      <MemberSignature Language="C#" Value="public static Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction GenerateNormalizedImagePerPage { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction GenerateNormalizedImagePerPage" />
      <MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction.GenerateNormalizedImagePerPage" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property GenerateNormalizedImagePerPage As BlobIndexerImageAction" />
      <MemberSignature Language="F#" Value="static member GenerateNormalizedImagePerPage : Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" Usage="Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction.GenerateNormalizedImagePerPage" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images.  Non-PDF file types will be treated the same as if "generateNormalizedImages" was set. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GenerateNormalizedImages">
      <MemberSignature Language="C#" Value="public static Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction GenerateNormalizedImages { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction GenerateNormalizedImages" />
      <MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction.GenerateNormalizedImages" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property GenerateNormalizedImages As BlobIndexerImageAction" />
      <MemberSignature Language="F#" Value="static member GenerateNormalizedImages : Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" Usage="Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction.GenerateNormalizedImages" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field.  This action requires that "dataToExtract" is set to "contentAndMetadata".  A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option. </summary>
        <value>To be added.</value>
        <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.Search.Documents.Indexes.Models.BlobIndexerImageAction.GetHashCode" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
      <MemberSignature Language="F#" Value="override this.GetHashCode : unit -&gt; int" Usage="blobIndexerImageAction.GetHashCode " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.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 the hash code for this instance.</summary>
        <returns>A 32-bit signed integer that is the hash code for this instance.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="None">
      <MemberSignature Language="C#" Value="public static Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction None { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction None" />
      <MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction.None" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property None As BlobIndexerImageAction" />
      <MemberSignature Language="F#" Value="static member None : Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" Usage="Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction.None" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Ignores embedded images or image files in the data set.  This is the default. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Equality">
      <MemberSignature Language="C#" Value="public static bool operator == (Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction left, Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction left, valuetype Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction right) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction.op_Equality(Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction,Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Operator == (left As BlobIndexerImageAction, right As BlobIndexerImageAction) As Boolean" />
      <MemberSignature Language="F#" Value="static member ( = ) : Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction * Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction -&gt; bool" Usage="left = right" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" />
        <Parameter Name="right" Type="Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" />
      </Parameters>
      <Docs>
        <param name="left">To be added.</param>
        <param name="right">To be added.</param>
        <summary> Determines if two <see cref="T:Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" /> values are the same. </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Implicit">
      <MemberSignature Language="C#" Value="public static implicit operator Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction (string value);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname valuetype Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction op_Implicit(string value) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction.op_Implicit(System.String)~Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" />
      <MemberSignature Language="VB.NET" Value="Public Shared Widening Operator CType (value As String) As BlobIndexerImageAction" />
      <MemberSignature Language="F#" Value="static member op_Implicit : string -&gt; Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" Usage="Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction.op_Implicit value" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="value">To be added.</param>
        <summary> Converts a string to a <see cref="T:Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" />. </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Inequality">
      <MemberSignature Language="C#" Value="public static bool operator != (Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction left, Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction left, valuetype Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction right) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction.op_Inequality(Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction,Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Operator != (left As BlobIndexerImageAction, right As BlobIndexerImageAction) As Boolean" />
      <MemberSignature Language="F#" Value="static member op_Inequality : Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction * Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction -&gt; bool" Usage="Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction.op_Inequality (left, right)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" />
        <Parameter Name="right" Type="Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" />
      </Parameters>
      <Docs>
        <param name="left">To be added.</param>
        <param name="right">To be added.</param>
        <summary> Determines if two <see cref="T:Azure.Search.Documents.Indexes.Models.BlobIndexerImageAction" /> values are not the same. </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </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.Search.Documents.Indexes.Models.BlobIndexerImageAction.ToString" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
      <MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="blobIndexerImageAction.ToString " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the fully qualified type name of this instance.</summary>
        <returns>The fully qualified type name.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
  </Members>
</Type>