AdlsClient.RenameAsync(String, String, Boolean, CancellationToken) メソッド

リファレンス

定義

名前空間:: Microsoft.Azure.DataLake.Store

アセンブリ:: Microsoft.Azure.DataLake.Store.dll

パッケージ:: Microsoft.Azure.DataLake.Store v1.1.24

パッケージ:: Microsoft.Azure.DataLake.Store v1.2.5-alpha

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ファイルまたはディレクトリの名前を変更するための非同期 API。ディレクトリの名前を変更する場合: 宛先が存在する場合は、ソースディレクトリを宛先の 1 レベル下に配置します。

public virtual System.Threading.Tasks.Task<bool> RenameAsync (string path, string destination, bool overwrite = false, System.Threading.CancellationToken cancelToken = default);

abstract member RenameAsync : string * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
override this.RenameAsync : string * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

Public Overridable Function RenameAsync (path As String, destination As String, Optional overwrite As Boolean = false, Optional cancelToken As CancellationToken = Nothing) As Task(Of Boolean)

パラメーター

path: String

ソースファイルまたはディレクトリのパス

destination: String

宛先パス。ディレクトリの場合: 宛先が存在する場合は、ソースディレクトリを宛先の 1 レベル下に配置します。 tthere が宛先パスのソース 1 レベルと同じ名前のサブディレクトリである場合、名前の変更は失敗します

overwrite: Boolean

file の場合: true の場合、コピー先ファイルが存在する場合は上書きされます。フォルダーの名前を変更しても、ターゲットを上書きすることはできません。

cancelToken: CancellationToken

要求を取り消す CancellationToken

戻り値

パスの名前が正常に変更された場合は True、それ以外の場合は false

適用対象