DownloadDirectoryOptions.xml

<Type Name="DownloadDirectoryOptions" FullName="Microsoft.Azure.Storage.DataMovement.DownloadDirectoryOptions">
  <TypeSignature Language="C#" Value="public sealed class DownloadDirectoryOptions : Microsoft.Azure.Storage.DataMovement.DirectoryOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit DownloadDirectoryOptions extends Microsoft.Azure.Storage.DataMovement.DirectoryOptions" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Storage.DataMovement.DownloadDirectoryOptions" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class DownloadDirectoryOptions&#xA;Inherits DirectoryOptions" />
  <TypeSignature Language="F#" Value="type DownloadDirectoryOptions = class&#xA;    inherit DirectoryOptions" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Storage.DataMovement</AssemblyName>
    <AssemblyVersion>2.0.3.0</AssemblyVersion>
    <AssemblyVersion>2.0.4.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.Azure.Storage.DataMovement.DirectoryOptions</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Represents a set of options that may be specified for download directory operation
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public DownloadDirectoryOptions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Storage.DataMovement.DownloadDirectoryOptions.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Storage.DataMovement</AssemblyName>
        <AssemblyVersion>2.0.4.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Delimiter">
      <MemberSignature Language="C#" Value="public char Delimiter { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance char Delimiter" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Storage.DataMovement.DownloadDirectoryOptions.Delimiter" />
      <MemberSignature Language="VB.NET" Value="Public Property Delimiter As Char" />
      <MemberSignature Language="F#" Value="member this.Delimiter : char with get, set" Usage="Microsoft.Azure.Storage.DataMovement.DownloadDirectoryOptions.Delimiter" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Storage.DataMovement</AssemblyName>
        <AssemblyVersion>2.0.4.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Char</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a char that indicates the delimiter character used to delimit virtual directories in a blob name.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DisableContentMD5Validation">
      <MemberSignature Language="C#" Value="public bool DisableContentMD5Validation { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool DisableContentMD5Validation" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Storage.DataMovement.DownloadDirectoryOptions.DisableContentMD5Validation" />
      <MemberSignature Language="VB.NET" Value="Public Property DisableContentMD5Validation As Boolean" />
      <MemberSignature Language="F#" Value="member this.DisableContentMD5Validation : bool with get, set" Usage="Microsoft.Azure.Storage.DataMovement.DownloadDirectoryOptions.DisableContentMD5Validation" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Storage.DataMovement</AssemblyName>
        <AssemblyVersion>2.0.4.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a flag that indicates whether to validate content MD5 or not when reading data from the source object.
            If set to true, source object content MD5 will be validated; otherwise, source object content MD5 will not be validated.
            If not specified, it defaults to false.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IncludeSnapshots">
      <MemberSignature Language="C#" Value="public bool IncludeSnapshots { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool IncludeSnapshots" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Storage.DataMovement.DownloadDirectoryOptions.IncludeSnapshots" />
      <MemberSignature Language="VB.NET" Value="Public Property IncludeSnapshots As Boolean" />
      <MemberSignature Language="F#" Value="member this.IncludeSnapshots : bool with get, set" Usage="Microsoft.Azure.Storage.DataMovement.DownloadDirectoryOptions.IncludeSnapshots" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Storage.DataMovement</AssemblyName>
        <AssemblyVersion>2.0.4.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a flag indicating whether to include snapshots when downloading from Azure blob storage.
            </summary>
        <value>To be added.</value>
        <remarks>
            If this flag is set to true, snapshots of the source blob will be copied to destination as
            separate files. Given a source blob name in the form of "x.y", where 'x' is the file
            name without extension and 'y' is the file name extension, the destination file name of blob
            snapshot is formatted as "x (%snapshot_time_stamp%).y".
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="PreserveSMBAttributes">
      <MemberSignature Language="C#" Value="public bool PreserveSMBAttributes { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool PreserveSMBAttributes" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Storage.DataMovement.DownloadDirectoryOptions.PreserveSMBAttributes" />
      <MemberSignature Language="VB.NET" Value="Public Property PreserveSMBAttributes As Boolean" />
      <MemberSignature Language="F#" Value="member this.PreserveSMBAttributes : bool with get, set" Usage="Microsoft.Azure.Storage.DataMovement.DownloadDirectoryOptions.PreserveSMBAttributes" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Storage.DataMovement</AssemblyName>
        <AssemblyVersion>2.0.4.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a flag that indicates whether to preserve SMB attributes during downloading.
            If set to true, destination Azure File's attributes will be set as source local file's attributes.
            SMB attributes includes last write time, creation time and <see cref="T:Microsoft.Azure.Storage.File.CloudFileNtfsAttributes" />.
            <see cref="T:Microsoft.Azure.Storage.File.CloudFileNtfsAttributes" /> will be converted to <see cref="T:System.IO.FileAttributes" /> ,
            and then set to destination local file.
            This flag only takes effect when uploading from local file to Azure File Service.
            Preserving SMB attributes is only supported on Windows.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PreserveSMBPermissions">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Storage.DataMovement.PreserveSMBPermissions PreserveSMBPermissions { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Storage.DataMovement.PreserveSMBPermissions PreserveSMBPermissions" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Storage.DataMovement.DownloadDirectoryOptions.PreserveSMBPermissions" />
      <MemberSignature Language="VB.NET" Value="Public Property PreserveSMBPermissions As PreserveSMBPermissions" />
      <MemberSignature Language="F#" Value="member this.PreserveSMBPermissions : Microsoft.Azure.Storage.DataMovement.PreserveSMBPermissions with get, set" Usage="Microsoft.Azure.Storage.DataMovement.DownloadDirectoryOptions.PreserveSMBPermissions" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Storage.DataMovement</AssemblyName>
        <AssemblyVersion>2.0.4.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Storage.DataMovement.PreserveSMBPermissions</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a value that indicates whether to preserve SMB permissions during downloading.
            Preserving SMB permissions is only supported on Windows.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>